Skip to content

SkillMedev/technical-writing-studio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Technical Writing Studio

Ship the docs people read - READMEs, guides, changelogs, API references, and SOPs. — built in-house by Skill Me.

Turn what you built into documentation people actually read. Generate a README, write tutorials and how-to guides, ship user-facing changelogs, stand up help articles and FAQs, design clear API references, document recurring work as SOPs, and produce authoritative whitepapers. Reach for this when a feature is done but undocumented and you need clear, accurate, maintainable docs fast - not a blank page.

If this is useful, star the repo — it's how we gauge what to build next.

Install

  • From the catalog: skillme.dev/pack/technical-writing-studio — install the whole pack into Claude in one step.
  • With the skills CLI: npx skills add SkillMedev/technical-writing-studio
  • Manually: copy any skills/<slug>/SKILL.md into your Claude skills directory.

Skills in this pack

  • README Generator — Generates a complete, professional README from a codebase scan - badges, usage, API docs, contributing guide. (external — see source)
  • Technical Blog Engine — Long-form technical writing with clear structure, runnable examples, and narrative flow. (external — see source)
  • User-Facing Changelog — Translates raw engineering release notes - commits, tickets, PR titles - into a user-facing changelog grouped as New, Improved, and Fixed, with a highlights section on top, benefit-first phrasing in the user's vocabulary, bugs described by their symptoms, and internal-only churn cut and flagged.
  • Help Documentation — Writes user-facing help-center articles - verb-first how-to guides, symptom-organized troubleshooting pages, and FAQs - with one task per article, exact UI labels, and a stated success result.
  • REST API Design — Designs REST API surfaces - resource naming, HTTP method and status-code semantics, error shapes, pagination, and filtering - and delivers an endpoint spec a consumer can build against without asking questions.
  • Process Documentation — Documents recurring processes as step-by-step SOPs with decision points, edge cases, and a named owner, so anyone can run the process correctly without asking.
  • Whitepaper Writer — Structures and writes authoritative B2B whitepapers - a standalone executive summary, a data-sized problem statement, methodology, evidence-driven findings, recommendations, and a soft call to action - flagging every claim that needs a real citation.

License

MIT — see LICENSE. Skills are portable SKILL.md files; the canonical copies live in the Skill Me catalog.

About

Docs people actually read — READMEs, guides, changelogs, and specs.

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors