skills.rest
7a336e6e
7a336e6eCOMMUNITY
Explore all skills by this author →
GitHub

Writing Documentation

Generate README files, API specifications, and architecture decision records for software projects.

1|2|Updated Feb 5, 2026
Search Tags:#documentation#technical writing#adr#readme#code comments#api docs
One-click install
npx skills add https://github.com/7a336e6e/skills --skill writing-documentation-7a336e6e
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Writing Documentation
Source: https://github.com/7a336e6e/skills/tree/main/shared/documentation
Command: npx skills add https://github.com/7a336e6e/skills --skill writing-documentation-7a336e6e

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that software projects are well-documented, making them easier to understand, use, and maintain for both developers and end-users.

Core Features & Use Cases

  • README Generation: Create concise project overviews with essential setup and stack information.
  • API Documentation: Generate and curate documentation for APIs, including examples and error codes.
  • Architecture Decision Records (ADRs): Document the reasoning behind key architectural choices.
  • Code Comments: Provide meaningful explanations for complex code sections.

Quick Start

Use the Writing Documentation skill to create a README.md file for a new Python project.

Frequently Asked Questions about Writing Documentation

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

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

To generate a README file, this Skill creates concise project overviews containing essential setup instructions and stack information. It automatically structures the content to ensure clarity and maintainability for developers.

What is the best way to write architecture decision records for my codebase?▼

The best way to write architecture decision records (ADRs) is to document the reasoning behind key architectural choices directly within your project. This Skill generates ADRs to ensure structural decisions remain clear and maintainable.

How do I create API documentation that includes examples and error codes?▼

To create API documentation with examples and error codes, this Skill generates and curates comprehensive API specifications. It supports OpenAPI generation to ensure your API endpoints are clearly documented.

Can I add meaningful code comments to complex code sections automatically?▼

Yes, you can add meaningful code comments automatically. This Skill provides explanations for complex code sections to enhance developer understanding and treats documentation as code for better maintainability.

When do I need to treat documentation as code in my software workflow?▼

You need to treat documentation as code when you want to ensure clarity and maintainability across READMEs, API specs, and ADRs. This approach integrates documentation generation directly into your software project lifecycle.

Related Skills

Explore More Content & Communication Skills→
zero-rehqzero-rehq

api-documentation-generator

Generate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.

Community
Intermediate
dodygdodyg

dotnet-api-docs

Generate DocFX metadata, OpenAPI specs, and versioned HTML documentation for .NET projects.

Community
Advanced
guccangguccang
3

test-driven-development

Create failing tests before implementing minimal production code.

Community
Intermediate
auxi-wardrobeauxi-wardrobe
1

ck:mintlify

Convert Markdown/MDX files into interactive documentation sites with Node.js.

Official
Advanced