What problem does it solve?
This Skill streamlines the process of creating, organizing, and updating project documentation within the docs/ directory, ensuring consistency and discoverability.
Core Features & Use Cases
- Structured Document Creation: Guides users through creating new Markdown files with appropriate templates and naming conventions.
- Categorization: Helps organize documents into logical categories (e.g.,
architecture/, api/, features/).
- Duplicate Checking: Provides steps to verify if a document already exists or if content can be merged.
- README Management: Assists in updating category and main README files to reflect new or modified documents.
- Use Case: When a new API endpoint is developed, use this Skill to create a corresponding
api/ document, ensuring it follows the standard template and is linked in the api/README.md.
Quick Start
Use the docs-writer skill to create a new document in the 'architecture' category with the title 'System Design Overview'.