documentation-creation

The Documentation Creation skill provides a structured framework for bootstrapping comprehensive project documentation from scratch. Designed for engineering teams and technical leads, this tool eliminates the manual burden of writing boilerplate documentation by performing a deep analysis of the codebase, framework configuration, and architectural metadata. By leveraging established templates, it ensures that your documentation remains synchronized with your project's implementation details, technology stack, and domain logic. It is specifically intended for the initial setup phase of new services or major components where consistent, high-quality documentation is required to facilitate onboarding and maintain system mastery.

• Automated discovery and documentation of technology stacks, including PHP, Symfony, Docker, and database configurations.

• Systematic mapping of bounded contexts, entities, and repository structures based on actual project file systems.

• Template-based generation for essential project artifacts such as getting started guides, API references, architecture decision records, and testing strategies.

• Automated verification routines to ensure that all documentation links, command examples, and directory paths remain valid and reflect current code implementation.

• Enforcement of documentation standards, including cross-linking requirements and adherence to project-wide design principles.

• Use this tool when launching new repositories to ensure rapid, consistent documentation coverage.

• Inputs typically include access to the project root, including files like composer.json, Makefile, and src/ directory structure.

• Outputs consist of a complete suite of markdown-formatted documentation files, organized to provide a holistic view of the project.

• Note: For ongoing synchronization after code changes, utilize the documentation-sync skill to prevent stale content.

• Ensure all project-specific metadata, such as entity names and bounded contexts, are correctly reflected in the generated output to maintain technical accuracy.