Which documentation formats does this skill support?

It supports a wide range of formats including README files, API references, architecture docs (with diagrams), user guides, and inline documentation comments.

Does it use my actual code to write the documentation?

Yes. The skill is designed to read your implementation files first to ensure that all documentation reflects the actual source of truth rather than assumptions.

Can I use it for blog posts or marketing copy?

No, this skill is specifically optimized for technical documentation. It is not intended for marketing copy, blog posts, or PR descriptions.

Can it help me fix existing, outdated documentation?

Absolutely. One of its primary uses is auditing existing docs to identify what is accurate, what has become stale, and what is missing based on the current codebase.

Are the generated code examples runnable?

The skill prioritizes creating copy-pasteable and runnable code examples with realistic values, ensuring they are tested or noted if they require specific environments.

Technical Documentation Writer

Name: Technical Documentation Writer
Author: wunki

bywunki

•

콘텐츠 관리

Produces high-quality READMEs, API references, and architecture guides by analyzing your project's source code and implementation details.

The Technical Documentation Writer skill automates the creation and refinement of technical documentation by treating your codebase as the single source of truth. It follows a rigorous process of identifying the target audience, reading implementation files, and applying professional writing principles like active voice and concise imperative language. Whether you need to build a quick-start guide, generate complex API references, or visualize system flows with Mermaid diagrams, this skill ensures your documentation is accurate, testable, and synchronized with your software's current state.

주요 기능

01Generates structured READMEs with quick-start, installation, and configuration sections.

02Audits existing documentation to identify stale information, inaccuracies, or missing details.

03Creates detailed API references including signatures, parameters, return values, and error cases.

04Produces architecture documentation with ASCII or Mermaid diagrams for system components.

0517 GitHub stars

06Enforces professional writing standards, including active voice and jargon elimination.

사용 사례

01Auto-generating API documentation for a backend service directly from its source code.

02Standardizing documentation style and tone across an entire software project's wiki.

03Building a comprehensive README and quick-start guide for a new open-source library.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add wunki/amplify tech-docs-writer

For use in Claude.ai and ChatGPT

Download Skill