skills.rest
curiositech
curiositechOFFICIAL
Explore all skills by this author →
WebsiteGitHub

technical-writer

Generate READMEs, API references, ADRs, and runbooks with validation scripts.

181|30|Updated Nov 16, 2025
Search Tags:#documentation#technical writing#adr#readme#runbook#api reference
One-click install
npx skills add https://github.com/curiositech/some_claude_skills --skill technical-writer-curiositech
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/curiositech/some_claude_skills/tree/main/.claude/skills/technical-writer
Command: npx skills add https://github.com/curiositech/some_claude_skills --skill technical-writer-curiositech

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps you create high-quality technical documentation, including READMEs, API references, and runbooks, ensuring clarity and completeness for your users and developers.

Core Features & Use Cases

  • Structured Documentation: Follows established frameworks like Diátaxis for tutorials, how-tos, explanations, and references.
  • Template Generation: Provides templates for READMEs, Architecture Decision Records (ADRs), API references, and runbooks.
  • Use Case: You need to document a new API endpoint. This Skill can generate a well-structured API reference document, including request/response examples, error codes, and authentication details, based on your input.

Quick Start

Use the technical-writer skill to generate a README file for a new project.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate an API reference document with request and response examples?▼

To generate an API reference, this Skill structures your input into a comprehensive document including request/response examples, error codes, and authentication details. It provides a dedicated template specifically for documenting API endpoints.

What is the Diátaxis framework and how does it structure technical writing?▼

The Diátaxis framework structures technical writing into four distinct types: tutorials, how-tos, explanations, and references. This Skill uses it as a foundational model to ensure your documentation serves different reader needs effectively.

How do I write an Architecture Decision Record for a new software project?▼

To write an Architecture Decision Record (ADR), this Skill provides standardized templates that capture your architectural choices and context. It ensures your ADRs follow established frameworks for clear team communication.

Can I validate the structure and content of my README and runbook documentation?▼

Yes, you can validate your README and runbook documentation using a dedicated script included in this Skill. It checks your content against established best practices to ensure clarity and completeness.

What is the best way to create a runbook for software engineering teams?▼

The best way to create a runbook is using this Skill's dedicated template, which formats operational procedures for software engineering teams. It ensures operational documentation adheres to established best practices.

Related Skills

Explore More Content & Communication Skills→
aurabxaurabx
3

automatic-documentation

Standardize creation and maintenance of READMEs, API specifications, and ADRs.

Official
Basic
cegit27cegit27
3

document-release

Synchronize markdown documentation with shipped code changes via git diffs.

Official
Intermediate
utkudarilmazutkudarilmaz
3

docs

Synchronize README.md, CLAUDE.md, and API references with code changes.

Community
Intermediate
Mahaboob26Mahaboob26

markdown-documentation

Create structured Markdown documentation with GitHub Flavored Markdown formatting.

Community
Basic