skills.rest
TheBushidoCollective
TheBushidoCollectiveOFFICIAL
Explore all skills by this author →
WebsiteGitHub

documentation

Generate structured documentation with code examples and parameter specifications.

187|20|Updated Nov 20, 2025
Search Tags:#documentation#readme#guides#api-docs#inline-comments
One-click install
npx skills add https://github.com/TheBushidoCollective/han --skill documentation-thebushidocollective
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/TheBushidoCollective/han/tree/main/core/skills/documentation
Command: npx skills add https://github.com/TheBushidoCollective/han --skill documentation-thebushidocollective

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps create and update documentation that is clear, useful, and tailored to the intended audience.

Core Features & Use Cases

  • Readme Crafting: Create compelling READMEs that explain purpose, setup, usage, and contributions.
  • API & Inline Documentation: Produce API docs and helpful inline comments to aid future developers.
  • Guides & ADRs: Generate technical guides and Architecture Decision Records for long-term context.

Quick Start

Create a README for a new module including purpose, quick start, and example usage.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write a README that clearly explains my project to new contributors?▼

A README should document purpose, setup instructions, usage examples, and contribution guidelines. Structure it with sections for quick start, dependencies, and troubleshooting so contributors can onboard quickly and understand the project's scope without diving into code.

What's the best way to document API endpoints and their parameters?▼

API documentation should specify each endpoint's purpose, request parameters, return values, error codes, and practical examples. Include parameter types, required fields, and sample payloads so developers can integrate without guessing implementation details.

How do I document complex algorithms so future developers understand the logic?▼

Document algorithms with inline comments explaining the approach, key decision points, and edge cases. Pair this with a technical guide or Architecture Decision Record that captures the reasoning, trade-offs, and maintenance notes for long-term context.

When should I use inline comments versus separate documentation?▼

Inline comments explain the 'why' behind tricky code sections and implementation details. Separate documentation covers broader topics: setup, usage patterns, architectural decisions, and troubleshooting that readers need before or outside the codebase.

Can I use Architecture Decision Records to document major technical choices?▼

Yes. Architecture Decision Records capture the rationale, alternatives considered, and consequences of significant technical decisions. They provide long-term context for why systems were designed a certain way, helping future maintainers understand constraints and trade-offs.

Related Skills

Explore More Software Engineering Skills→
stephanjstephanj
9

crafting-effective-readmes

Generate audience-aware README templates with section checklists and style guides.

Community
Intermediate
jangtrinhjangtrinh

ck:deploy

Detect hosting platforms from repository docs and deploy projects automatically.

Community
Intermediate
lobehublobehub
81.4k

microcopy

Guide UI writers to produce consistent bilingual microcopy in English and Chinese.

Official
Basic
luongnv89luongnv89
40.9k

api-documentation-generator

Generate API documentation from source code into Markdown and OpenAPI-style specs.

Community
Basic