Prompt file imported from herveDarritchon/foundryvtt-swerpg (.github/prompts/retro-doc.prompt.md). Copyright stays with the author.

Phase 1 : Inspect and Document

Look at all the project #search/codebase :

• Inspect the code and document it using UML, Sequence diagrams, Class diagrams, and other relevant diagrams using Mermaid syntax.

• Create or update the documentation files in the appropriate subfolder.

• Identify all the Functional Requirements addressed by the code, and document them as MOSCOW requirements.

• Identify all the Non-Functional Requirements addressed by the code, and document them.

• Identify all the Deployment scenarios addressed by the code, and document them.

• Identify all the Usability features addressed by the code, and document them.

• Identify all the Patterns used in the code, and document them.

• Identify all the Models used in the code, and document them.

• Identify all the major Workflows implemented in the code, and document them.

• when you write functional requirements, use the format:

• Requirement: Short description of the requirement.

• Type: Must/Should/Could/Won't

• Rationale: Explanation of why this requirement is needed.

• Source: Reference to the code or module that implements this requirement.

• Priority: Must have/Should have/Could have/Won't have

• Category: Performance/Security/Usability/Maintainability/Scalability/etc.

For all the above points, create a technical documentation in markdown format with mermaid diagrams if needed.

Put this in a specific subfolder in documentation folder based on the module name.

Create or update a DOCUMENTATION_PROCESS.md file with the steps to create the documentation, from this prompt telling which files and folders have been analyzed, used to create the documentation.