Skills Guide

Technical Writer

VerifiedSafe

Generates technical documentation such as READMEs, specifications, architecture documents, and runbooks. Uses templates with placeholders and follows best practices including Mermaid diagrams and file organization.

Download and use
Sby Skills Guide Bot
DocumentationIntermediate
6/2/2026
Claude Code
#technical-documentation#readme#runbook#architecture#writing

Recommended for

Claude CodeAuto documentationSEO & contentWriter / marketer

Automated summary

Generates technical documentation including READMEs, specifications, architecture documents, and runbooks.

Strengths

  • Uses standardized templates for consistency
  • Incorporates Mermaid diagrams for visuals
  • Provides clear file organization

Limitations

  • Relies on provided templates which may not fit all cases
  • Requires user feedback for refinement
  • May not cover highly specialized documentation types
When to use it

Use this skill when creating or updating technical documentation for a project.

When not to use it

Do not use it for creative or non-technical writing.

Security analysis

Safe
Quality score85/100

The skill only uses Read, Write, Grep, Glob tools, which perform local filesystem operations. It does not invoke external commands, network access, or destructive actions. There is no risk of data exfiltration or system compromise.

No concerns found

How this analysis is made

Examples

Generate a README
Write a comprehensive README for my Python project that includes installation, usage, and contribution guidelines.
Create a deployment runbook
Create a runbook for deploying the microservice to production, including steps for rolling back.
Document system architecture
Document the architecture of the current system, including components, data flow, and a Mermaid diagram.

name: technical-writer description: Generate technical documentation including READMEs, specifications, architecture documents, and runbooks. Use when creating or updating any technical documentation. allowed-tools: Read, Write, Grep, Glob

Technical Writer

As a technical writer it's your job to accurately document the technical solution at hand in an engaging way.

Instructions

  1. Review the technical solution provided to you for documentation using the Read tool
  2. Follow up with any questions that would affect how you write your documentation
  3. Write documentation using the templates provided to you using the Write tool
  4. Ask for review and feedback on what you've written; If there is feedback, return to step 2

Document Templates

For documentation templates you can use see the templates folder

Templates use the %PLACEHOLDER% convention (e.g., %PROJECT NAME%, %RUNBOOK TITLE%) to mark values that should be replaced with actual content when generating documentation.

Best Practices

  • READMEs should provide a comprehensive overview. See this example
  • Docs and runbooks should be focussed on one subject each.
  • Docs should contain relevant links to external documentation.
  • Use inline or dedicated mermaid chart diagrams for diagrams

File Organization

When deciding where to put files, reference this

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/technical-writer-mmbizkkp/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/technical-writer-mmbizkkp' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/technical-writer-mmbizkkp/download' --output '.skill-downloads/technical-writer-mmbizkkp/SKILL.md.part' && mv '.skill-downloads/technical-writer-mmbizkkp/SKILL.md.part' '.skill-downloads/technical-writer-mmbizkkp/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

Tools declared by the author (check availability in your agent): Read, Write, Grep, Glob

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/technical-writer-mmbizkkp/SKILL.md' && test -s '.skill-downloads/technical-writer-mmbizkkp/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/technical-writer' && cp -R '.skill-downloads/technical-writer-mmbizkkp' '.claude/skills/technical-writer'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/technical-writer-mmbizkkp'

openskills read 'technical-writer-mmbizkkp'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/technical-writer-mmbizkkp/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544
Skills Guide Bot

Create Architecture Decision Record

Documentation

Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.

Claude CodeintermediateSafe 69,659
Skills Guide Bot

Plan update with deep research

Documentation

Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.

Claude CodeadvancedSafe 248,015
Skills Guide Bot