documentation

Create and maintain technical documentation for codebases, APIs, and runbooks.

1|Updated Mar 30, 2026
One-click install
npx skills add https://github.com/ilove323/comlan-skills --skill documentation-ilove323
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/ilove323/comlan-skills/tree/main/engineering/skills/documentation
Command: npx skills add https://github.com/ilove323/comlan-skills --skill documentation-ilove323

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams create and maintain clear, up-to-date technical documentation for codebases, APIs, and runbooks, reducing onboarding time and knowledge gaps.

Core Features & Use Cases

  • README drafting: Quick start guides and project overviews.
  • API documentation: Endpoint references, usage examples, and authentication details.
  • Runbooks and architecture documents: Operational procedures and high-level designs.
  • Onboarding guides: Environment setup and key system relationships.

Quick Start

为新项目生成完整的 README 与 API 文档草案。

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?

Generate a README by applying structured templates to your codebase, creating quick start guides and project overviews. It enforces consistent formatting to reduce onboarding time and eliminate knowledge gaps for new developers.

What is the best way to write API documentation with endpoint references and usage examples?

Write API documentation by using enforced content types to structure endpoint references, authentication details, and usage examples. This approach streamlines writing and updates while maintaining clear, actionable API docs.

How do I create runbooks and architecture docs for operational procedures?

Create runbooks and architecture docs by applying actionable templates to capture operational procedures and high-level designs. This ensures your technical documentation remains clear, structured, and up-to-date across software projects.

Can I use this to draft onboarding guides for environment setup and system relationships?

Yes, you can draft onboarding guides that detail environment setup and key system relationships. It uses actionable templates to streamline the writing process, reducing onboarding time and bridging team knowledge gaps.

How do I maintain up-to-date technical writing across multiple codebases?

Maintain up-to-date technical writing by enforcing structured content types and consistent formatting across your codebases. This systematic approach streamlines updates to README files, API docs, and runbooks without manual overhead.