skills.rest
zhaono1
zhaono1COMMUNITY
Explore all skills by this author →
GitHub

documentation-engineer

Generate READMEs, API docs, and code comments from code and design descriptions.

69|11|Updated Jan 10, 2026
Search Tags:#templates#documentation#writing#readme#style-guide#code-comments#api-docs
One-click install
npx skills add https://github.com/zhaono1/agent-playbook --skill documentation-engineer-zhaono1
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-engineer
Source: https://github.com/zhaono1/agent-playbook/tree/main/skills/documentation-engineer
Command: npx skills add https://github.com/zhaono1/agent-playbook --skill documentation-engineer-zhaono1

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Documentation is often inconsistent and time-consuming to produce, hindering onboarding and knowledge transfer.

Core Features & Use Cases

  • README generation: Create project overviews, installation steps, usage examples, and contribution guidelines.
  • API & code documentation: Produce endpoint descriptions, parameter schemas, and inline code comments.
  • Documentation templates & style guidance: Enforce templates, examples, and formatting rules to maintain quality across projects.

Quick Start

Ask me to write documentation for your project, create a README, or document a code module.

Frequently Asked Questions about documentation-engineer

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

FAQPage Schema
How do I generate a README from an existing codebase?▼

To generate a README, provide your codebase and design descriptions to create project overviews, installation steps, usage examples, and contribution guidelines using structured templates.

What's the best way to document API endpoints and parameter schemas?▼

Documenting API endpoints involves producing endpoint descriptions, parameter schemas, and inline code comments. The generation process applies formatting rules and templates to maintain consistency across your API docs.

How do I enforce a consistent style guide for technical writing across projects?▼

Enforcing a style guide for technical writing applies predefined templates, formatting rules, and documentation examples. This ensures consistent quality and structure across all generated project documentation.

Can I create architecture diagrams and code comments from design descriptions?▼

Yes, creating architecture diagrams and code comments from design descriptions is supported. The process generates clear, maintainable technical documentation by applying structured sections to your software design inputs.

Does this documentation generation work for any software project?▼

Yes, this documentation generation applies to software projects needing READMEs, API docs, architecture diagrams, and code comments. It uses templates and style guides to maintain quality across various contexts.

Related Skills

Explore More Content & Communication Skills→
j-showj-show

doc-helper

Generate JSDoc, inline comments, and README files from source code.

Official
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
plastikawebplastikaweb
1

code-documentation

Generate Markdown documentation, API references, and architecture guides from codebases.

Community
Basic
spideynolovespideynolove
2

api-documentation-generator

Generate OpenAPI specs and endpoint documentation from source code.

Community
Advanced