Generates OpenAPI-compliant API documentation and improves READMEs for software projects.
npx skills add https://github.com/akvo/akvo-rag --skill bmad-writer
Please help me install this Agent Skill. Skill: bmad-writer Source: https://github.com/akvo/akvo-rag/tree/main/.agent/skills/bmad-writer Command: npx skills add https://github.com/akvo/akvo-rag --skill bmad-writer
This Skill streamlines the creation and improvement of technical documentation, ensuring clarity, accuracy, and adherence to standards for APIs, architecture, and user guides.
Use the bmad-writer skill to create an OpenAPI documentation for the /users endpoint.
High-intent search queries and answers about installing and using this skill.
You can generate OpenAPI compliant API documentation by providing your endpoint details. The Skill produces Swagger and OpenAPI specifications, ensuring your API references adhere to industry standards for clarity and accuracy.
Creating architecture diagrams is best handled using Mermaid syntax. The Skill generates system overviews and diagrams that visually map your architecture, integrating directly into your docs-as-code workflow.
Yes, you can audit existing technical documentation for quality and compliance. The Skill reviews your current docs against standards like CommonMark, identifies gaps, and highlights areas needing improvement.
You write task-oriented user guides by focusing on clear, actionable steps. The Skill develops getting started guides, tutorials, and FAQs that adhere to docs-as-code principles, ensuring users can follow procedures easily.
Yes, bmad-writer supports CommonMark for README improvements. It enhances project READMEs by refining markdown formatting and content clarity, ensuring better completeness and adherence to documentation standards.
You need docs-as-code principles when managing technical writing alongside software development. This approach treats documentation like code, using standards like CommonMark and Mermaid to integrate system overviews and API specs directly into your project.
thisisqubikaCreate technical diagrams with Mermaid syntax for software documentation.
JongsixGenerate technical documentation from source code and API definitions.
nimadorostkarGenerate Mermaid diagrams as code for version-controlled documentation.
giuseppe-trisciuoglioGenerate OpenAPI 3.0 documentation and Swagger UI for Spring Boot 3.x applications.
