Guide structured documentation creation with single-type discipline and source verification.
npx skills add https://github.com/cjohnhanson/almanac --skill doc-editing
Please help me install this Agent Skill. Skill: doc-editing Source: https://github.com/cjohnhanson/almanac/tree/main/skills/doc-editing Command: npx skills add https://github.com/cjohnhanson/almanac --skill doc-editing
This Skill addresses the challenge of producing comprehensive and coherent documentation by guiding the user through a structured process, from defining the scope to final review.
Use the doc-editing skill to start a new documentation project by providing the document type, audience, purpose, and scope.
High-intent search queries and answers about installing and using this skill.
To write structured documentation, follow a defined process that guides you from scope definition to final review, verifying technical claims against source code or CLI outputs to ensure accuracy and consistency throughout the document.
Enforcing a single documentation type per file is achieved by applying type discipline, such as maintaining one Diátaxis type per document, which ensures clarity and prevents mixed instructional and reference content.
To start a documentation project, provide the document type, target audience, purpose, and scope, which initiates a three-phase structured process to produce well-organized and coherent project guides.
Yes, you can verify technical claims against source material during documentation writing, which ensures that the technical accuracy of your project guides is maintained by checking claims against source code or CLI outputs.
Structured documentation writing works for complex project guides by guiding you through a three-phase process that ensures the resulting documentation is both technically accurate and easy to follow for the intended audience.
Using a defined process for technical documentation writing solves the challenge of producing comprehensive and coherent documents by enforcing type discipline and verifying technical claims against source material for accuracy.
bennybennisonGather audience, purpose, source material, and format to create documentation.
dngioidevAutomate technical documentation creation and maintenance with VitePress and Markdown.
silaslopes100Extract algorithms, control flows, and data dictionaries from source code.
zero-rehqGenerate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.
