skills.rest
anthropics
anthropicsOFFICIAL
Explore all skills by this author →
WebsiteGitHub

documentation

Generate and maintain technical documentation such as READMEs, API specs, and runbooks.

23.4k|2.8k|Updated Jan 23, 2026
Search Tags:#documentation#onboarding#technical writing#readme#api docs#runbook
One-click install
npx skills add https://github.com/anthropics/knowledge-work-plugins --skill documentation-anthropics
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/anthropics/knowledge-work-plugins/tree/main/engineering/skills/documentation
Command: npx skills add https://github.com/anthropics/knowledge-work-plugins --skill documentation-anthropics

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation and maintenance of various types of technical documentation, ensuring clarity and consistency for different audiences.

Core Features & Use Cases

  • Document Generation: Creates READMEs, API documentation, runbooks, architecture docs, and onboarding guides.
  • Content Structuring: Follows best practices for readability and maintainability.
  • Use Case: Generate a comprehensive README for a new software project, including setup instructions, usage examples, and contribution guidelines.

Quick Start

Write a README for the 'user-authentication' service.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate a README for a new software project?▼

To generate a README, provide the project name and details to create clear documentation including setup instructions, usage examples, and contribution guidelines. It structures content for readability and maintainability.

What's the best way to write API documentation and runbooks?▼

Writing API documentation and runbooks is best handled by generating reader-centric content that prioritizes essential information and uses examples. This ensures clear communication of operational procedures and specifications.

Can I create onboarding guides and architecture diagrams with technical writing tools?▼

Yes, you can create onboarding guides and architecture diagrams as part of technical documentation. It supports generating project overviews and operational procedures tailored for different audiences.

Does this approach work for maintaining existing technical documentation?▼

Maintaining existing technical documentation is supported. It streamlines updates to READMEs and runbooks, ensuring clarity and consistency while adhering to best practices for readability across software development projects.

When do I need formal API specifications and runbooks?▼

You need formal API specifications and runbooks when clear communication is required for software development and operational procedures. They ensure essential information is prioritized for reader-centricity and maintainability.

Related Skills

Explore More Software Engineering Skills→
henrybravohenrybravo

reverse-engineering

Analyze existing codebases to extract specifications and generate technical documentation.

Community
Advanced
SSiertsemaSSiertsema

documentation-tooling-selection

Evaluate documentation tooling against audience, content, and technical criteria.

Community
Advanced
Logos-LiberLogos-Liber
17

documentation-tools

Compare static site generators and documentation platforms for technical documentation workflows.

Official
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate