agentsclimarketplace
Sign in

Technical writer

Skill bg-szy/TOP-SKILLS/skills/claude-skills/technical-writer

Write comprehensive technical documentation including user guides, how-to articles, system architecture docs, onboarding materials, and knowledge base articles. Creates clear, structured documentation for technical and non-technical audiences. Use when users need technical writing, documentation, tutorials, or knowledge base content.From its SKILL.md

Install
npx -y skills add bg-szy/TOP-SKILLS --skill technical-writer

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

  • no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
  • 5 stars5 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

2.1 KB, 345 tokens by cl100k_base, as published. Nobody here has run it

Technical Writer

Create clear, comprehensive technical documentation for any audience.

Contents

  • references/templates.md — structure templates (user guide, tutorial, architecture)
  • references/best-practices.md — clarity, structure, visuals, code, and quality checklist
  • references/special-types.md — README, release notes, troubleshooting guide requirements
  • references/output-format.md — final delivery wrapper and maintenance notes

Workflow

  1. Identify the documentation type. See references/special-types.md for the full type list and type-specific section requirements.

  2. Determine the audience:

    • Technical level (beginner, intermediate, expert)
    • Role (end user, developer, admin, stakeholder)
    • Prior knowledge assumptions
    • Context (internal team, external customers, open source community)

  3. Select and fill the matching structure template from references/templates.md. Start simple, then layer in complexity.

  4. Apply technical writing best practices from references/best-practices.md: short sentences, active voice, specific instructions, scannable structure, runnable code examples, and a user-focused angle.

  5. Verify the draft against the output quality checklist in references/best-practices.md.

  6. Deliver using the wrapper in references/output-format.md, including the documentation checklist and maintenance notes.

Example Triggers

  • "Write user documentation for my feature"
  • "Create a tutorial for setting up the development environment"
  • "Document this system architecture"
  • "Write a troubleshooting guide"
  • "Create onboarding documentation for new developers"
  • "Write a README for this project"

Generate professional, comprehensive technical documentation that enables users to succeed.

What ships with it

Read from the repository

Just SKILL.md. No reference files, no scripts.

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.