ddd-doc-steward

What problem does it solve?

This Skill ensures your project documentation (in ~/project/docs) is always a Single Source of Truth (SSOT) by automatically synchronizing it with your codebase and configurations. It prevents documentation from becoming outdated or inaccurate.

Core Features & Use Cases

• Automated Documentation Auditing: Scans your project and documentation directories to identify discrepancies.
• Incremental Documentation Generation/Updates: Creates new documentation or updates existing files based on code changes, prioritizing specific directories like guides and integrations.
• Evidence-Based Documentation: Requires all facts in documentation to be backed by code, configuration, or command paths, marking unverified information with 【待确认】.
• Use Case: After adding a new API endpoint, this Skill can automatically generate or update the relevant integration documentation, including its purpose, scope, evidence (code path), and related links, ensuring developers always have accurate information.

Quick Start

Use the ddd-doc-steward skill to update documentation for the project located at ~/my-app and output changes as a patch diff.