How to write functional documentation

The functional documentation (currently specs

The functional documentation describes what Prestashop IS.

This documentation is part of the PrestaShop project documentation package which includes :

• This functional documentation

• Developers documentation

• Tests documentation

• User documentation
• Content Style Guide

• UI Kit / Design system

Purpose

1. To let testers & QA analysts know what test to build and run.

2. To help people (and especially testers, QA analysts) to qualify an issue as a bug or a feature request

3. To help developers, product managers, designers (...) understand how the application works

Structure

• UX/UI describes page to page description of PrestaShop software with an UX point of view

  • Back office

  • Front office

  • Common components

  • Installer

• Business rules

  • Catalog referential

    • Sub sections ? (Categories, attributes, images, files ...) ? ( TBD )

  • Pricing, Taxes & Cart rules

    • Sub sections

  • Stock management

  • Orders

    • Orders management

    • Subsections ? ( Invoices, Return & Refund ...)

  • CRM

Templates

• Page templates (for UX/UI)

• Business rules template