documentation

To generate API documentation, provide a concise prompt describing your REST service endpoints, authentication details, and payload examples. The skill outputs structured docs including error schemas and examples, mirroring professional technical writing practices.

Writing architecture decision records is best handled by providing your architectural context to the skill, which then drafts structured ADRs, diagrams, and architecture documentation using consistent templates to ensure maintainable technical docs.

Yes, you can use templates to ensure consistent style. The skill is template-based, automatically applying uniform formatting and structure across READMEs, contribution guides, getting-started sections, and troubleshooting tutorials.

To create a README for developer onboarding, prompt the skill with your project details. It drafts comprehensive READMEs, contribution guides, and getting-started sections that improve API usability and accelerate developer onboarding.

Yes, the tool supports generating in-line code documentation. It creates comments, docstrings, and in-line docs directly from your code, automating the upkeep of accurate technical documentation across your codebase.

To document OpenAPI and GraphQL schemas, provide your schema definitions to the skill. It generates comprehensive API documentation complete with payload examples, authentication details, and error schemas for improved API usability.