documentation-creation

Documentation Creation 技能为从头开始构建全面的项目文档提供了结构化框架。该工具专为工程团队和技术负责人设计，通过对代码库、框架配置和架构元数据进行深入分析，消除了编写样板文档的手动负担。利用既定的模板，它确保您的文档与项目的实现细节、技术栈和领域逻辑保持同步。它专门用于新服务或主要组件的初始设置阶段，在这些阶段需要一致、高质量的文档来促进入职并保持对系统的掌控。

• 自动发现并记录技术栈，包括 PHP、Symfony、Docker 和数据库配置。

• 基于实际项目文件系统，对有界上下文、实体和存储库结构进行系统性映射。

• 为必要的项目工件提供基于模板的生成，例如入门指南、API 参考、架构决策记录和测试策略。

• 自动验证例程，确保所有文档链接、命令示例和目录路径保持有效并反映当前的代码实现。

• 强制执行文档标准，包括交叉链接要求和对项目范围内设计原则的遵守。

• 在启动新存储库时使用此工具，以确保快速、一致的文档覆盖率。

• 输入通常包括对项目根目录的访问权限，包括 composer.json、Makefile 和 src/ 目录结构等文件。

• 输出由一整套 Markdown 格式的文档文件组成，旨在提供项目的整体视图。

• 注意：对于代码更改后的持续同步，请使用 documentation-sync 技能以防止内容过时。

• 确保所有项目特定的元数据（例如实体名称和有界上下文）都在生成的输出中正确反映，以保持技术准确性。