skills.rest
coakenfold
coakenfoldCOMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Generate Markdown documentation from source code and API references.

Updated Feb 11, 2026
Search Tags:#documentation#markdown#onboarding#readme#code-comments#api-docs#documentation-quality
One-click install
npx skills add https://github.com/coakenfold/p-100226 --skill technical-writer-coakenfold
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/coakenfold/p-100226/tree/main/.claude/skills/technical-writer
Command: npx skills add https://github.com/coakenfold/p-100226 --skill technical-writer-coakenfold

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often lags behind code, making onboarding and maintenance harder. This Skill automates the creation of clear, accurate READMEs, API references, and inline documentation from source material to reduce drift and improve accessibility.

Core Features & Use Cases

  • Automated README generation: Generate up-to-date project READMEs from source files and configuration.
  • API reference creation: Produce structured API docs from annotations and type definitions.
  • Inline documentation: Create JSDoc-style comments and in-code documentation scaffolds based on code analysis.

Quick Start

Use the skill to generate a ready-to-publish API reference for your project's frontend and backend modules.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate a README from source files automatically?▼

Generate a project README from source files by reading the codebase and configuration to produce structured Markdown documentation that reflects current project conventions.

Can I create API reference docs directly from code annotations?▼

Yes, you can create API references directly from code annotations and type definitions, outputting structured Markdown documentation that improves developer onboarding and API usage.

How do I add inline documentation and code comments to existing modules?▼

Add inline documentation by analyzing existing source code to generate JSDoc-style comments and in-code documentation scaffolds without executing the code.

Does the documentation generation process execute my code?▼

No, the documentation generation process strictly reads source files and API references to produce Markdown documentation without executing any code.

What is the best way to keep architecture decision records consistent with code?▼

Keep architecture decision records consistent by reading source material to produce Markdown documentation with a consistent structure that follows established project conventions.

Related Skills

Explore More Content & Communication Skills→
penghang1223penghang1223
1

doc-generator

Extract code comments and annotations into Markdown, JSON, or OpenAPI YAML documentation.

Community
Intermediate
TurnaboutHeroTurnaboutHero
12

scribe

Generate READMEs, API references, and architecture guides from project notes.

Community
Basic
julianobarbosajulianobarbosa
7

reviewing-code

Review code for quality, bugs, security issues, and best practices using Codex.

Community
Advanced
yknothingyknothing
1

documentation

Automate creation and maintenance of technical documentation tied to code changes.

Community
Intermediate