Structure README, API docs, changelogs, and code comments with templates.
npx skills add https://github.com/curphey/bosun --skill docs-writer-curphey
Please help me install this Agent Skill. Skill: docs-writer Source: https://github.com/curphey/bosun/tree/main/skills/docs-writer Command: npx skills add https://github.com/curphey/bosun --skill docs-writer-curphey
Documentation exists to help readers, not to showcase what the writer knows. This skill guides writing clear, useful documentation that people actually read.
Draft a concise, reader-focused README following the templates and examples in references/readme-templates.md.
High-intent search queries and answers about installing and using this skill.
To write a README that people actually read, focus on the reader's needs rather than showcasing knowledge. Use structured templates, quick start sections, and scannable layouts to deliver clear, useful guidance.
The best way to structure API documentation for readability is applying structured sections and best practices like scannable layouts and example correctness. This ensures API references are clear and usable for developers.
Effective in-code comments and changelogs require reader-focused writing and structured processes. Applying best practices ensures your documentation remains scannable and useful across software projects.
Docs-as-code does not require specific dependencies or environments. You can apply structured templates and writing patterns directly to your software projects without external tools to improve documentation quality.
You should not use structured templates for documentation when it prioritizes the writer's knowledge over the reader's needs. Documentation exists to help readers, so avoid templates that create friction or reduce scannability.
J-PsterValidate and create mandatory project documentation baseline files before implementation.
brainbrewlabsPublishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.
Jaydpatel01Enforce code correctness, readability, and safety with linters and type checkers.
hlbbbbbbbSummarize content from URLs, local files, and YouTube videos.
