Draft reader-friendly documentation for proposals, specs, ADRs, READMEs, and runbooks.
npx skills add https://github.com/qdzsh/gsd-revamp --skill write-docs-qdzsh
Please help me install this Agent Skill. Skill: write-docs Source: https://github.com/qdzsh/gsd-revamp/tree/main/src/resources/skills/write-docs Command: npx skills add https://github.com/qdzsh/gsd-revamp --skill write-docs-qdzsh
Create durable, reader-friendly documentation that communicates project intent to someone unfamiliar with the codebase, avoiding guesswork or misinterpretation.
Draft a public README section for a new feature following the three-stage outline.
High-intent search queries and answers about installing and using this skill.
Technical proposals require a three-stage workflow: context gathering, outline refinement, and reader-testing. This approach ensures your documentation clearly communicates project intent and prevents misinterpretation by guiding content structure before drafting begins.
The best way to structure an ADR is using a workflow that refines the outline based on audience needs, then validates clarity through a reader-test. This ensures the decision record communicates project intent clearly and aligns with public entry points.
To create a clear runbook, gather context and refine an outline before drafting, then perform a reader-test to check audience understanding. This structured workflow ensures the runbook avoids guesswork and communicates effectively to someone unfamiliar with the codebase.
Yes, you can draft a public README section for a new feature using the three-stage workflow. The process guides you from context gathering to outline refinement and reader-testing, ensuring the README is reader-friendly and clear before public release.
You need to update public decision records (DECISIONS.md) during the documentation publishing stage. This step ensures your technical specs and ADRs are linked to relevant entry points and maintain alignment with public-facing decision logs.
Yes, this process works for mintlify-docs and similar public-facing docs locations. It targets proposals, technical specs, and READMEs across these folders, guiding the full doc lifecycle from initial context gathering through to final public release.
nextcSynchronize project documentation with codebase changes across CLAUDE.md, tasks.md, specs, design.md, changelog, and glossary.
spencerbeggsValidate README and docs files for formatting, prose style, and badge standards.
trungdo9Answer technical and architectural questions by referencing actual code files.
xloxn69Generate structured deployment guides with rollback procedures and monitoring steps.
