technical-writer

Write and improve developer-facing technical documentation in Markdown format.

8|1|Updated Feb 27, 2026

Search Tags:#changelog #documentation #adr #readme #runbook #technical-writing #api-docs

Ready to run

npx skills add https://github.com/thesaifalitai/claude-setup --skill technical-writer-thesaifalitai

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/thesaifalitai/claude-setup/tree/main/skills/technical-writer
Command: npx skills add https://github.com/thesaifalitai/claude-setup --skill technical-writer-thesaifalitai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produces and improves developer-facing technical documentation so projects have clear, scannable, and actionable docs that reduce onboarding friction and support recurring maintenance.

Core Features & Use Cases

Comprehensive templates: Ready-made README, ADR, runbook, changelog, postmortem, and API reference templates tailored for engineering teams.
API and reference authoring: Guidance and OpenAPI/Swagger examples for accurate API documentation and example requests.
Incident and process docs: Fast runbooks and postmortem templates to accelerate incident response and learning.
Checklist-driven quality: Documentation checklist to ensure examples, parameters, errors, and contribution guidance are present.

Quick Start

Ask the technical-writer to improve a README by providing the project's purpose, installation steps, a minimal usage example, and a list of public API endpoints.

Frequently Asked Questions about technical-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write a README that developers will actually read?▼

To write a README developers read, provide structured inputs like project purpose, installation steps, and minimal usage examples to generate scannable, Markdown-formatted documentation. This reduces onboarding friction by ensuring essential setup and usage details are clear and actionable.

What is the best way to document an OpenAPI or Swagger API reference?▼

Documenting an OpenAPI or Swagger API reference requires providing API schemas and code examples to produce accurate, style-guide-compliant Markdown outputs. This ensures example requests, parameters, and errors are clearly presented for engineering teams consuming the API.

How do I create a runbook or postmortem template for incident response?▼

Creating a runbook or postmortem template for incident response involves providing structured inputs like system architecture and incident timelines. This produces fast, scannable Markdown templates that accelerate incident response and document learning for future prevention.

When do I need an Architecture Decision Record, and how do I structure one?▼

You need an Architecture Decision Record (ADR) when making significant technical choices that require documentation and team alignment. Structure an ADR by providing the project purpose and architectural context to generate a standardized, Markdown-formatted decision log.

Does this technical writing tool support generating release notes from changelogs?▼

Yes, generating release notes from changelogs is supported by providing structured inputs like version updates and acceptance criteria. It produces Markdown-formatted, scannable changelogs that ensure contribution guidance and changes are clearly documented for recurring maintenance.

What should I include in an onboarding guide for a new engineering team member?▼

An onboarding guide for a new engineering team member should include installation steps, minimal usage examples, and API endpoints. Providing these structured inputs generates a scannable, checklist-driven Markdown document that reduces onboarding friction and accelerates developer productivity.