technical-writing

Generate API documentation, user guides, tutorials, and technical specifications.

14|11|Updated Dec 1, 2025

Search Tags:#templates #documentation #technical-writing #api-docs #user-guides #writing-guidelines

Ready to run

npx skills add https://github.com/DauQuangThanh/hanoi-rainbow --skill technical-writing-dauquangthanh

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/DauQuangThanh/hanoi-rainbow/tree/main/skills/technical-writing
Command: npx skills add https://github.com/DauQuangThanh/hanoi-rainbow --skill technical-writing-dauquangthanh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

High-quality technical documentation is often produced inconsistently, hard to maintain, and difficult to discover. This skill provides structured guidance, templates, and best practices to generate API docs, user guides, tutorials, architecture documents, README files, release notes, and technical specifications with clarity and consistency.

Core Features & Use Cases

Templates and checklists to ensure consistency across documents.
Guidance for API docs, user guides, architecture documents, and tutorials, including examples and templates.
References to standardized patterns and guidelines to speed up authoring.

Quick Start

Generate a complete API documentation draft for a new project using the API docs template.

Frequently Asked Questions about technical-writing

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

FAQPage Schema

How do I generate API documentation for a new software project?▼

To generate API documentation, use structured templates and writing guidelines that ensure consistent terminology and clarity. This approach produces high-quality API docs, user guides, and technical specifications with linked references, speeding up the authoring process.

What is the best way to maintain consistency across technical documentation?▼

Maintaining consistency across technical documentation requires using standardized templates and checklists. Applying structured writing guidelines ensures that API docs, user guides, and release notes follow uniform terminology and formatting patterns throughout the software project.

Can I use these templates to write tutorials and architecture documents?▼

Yes, you can use these templates to write tutorials and architecture documents. The provided guidance covers a wide range of technical documentation including API docs, user guides, README files, release notes, and technical specifications for software projects.

When do I need structured writing guidelines for user guides and release notes?▼

You need structured writing guidelines for user guides and release notes when authoring technical documentation that must be easily discoverable and maintainable. Standardized patterns prevent inconsistencies, ensuring professional tech docs are produced clearly across software projects.

Does this approach support generating README files and technical specifications?▼

Yes, this approach supports generating README files and technical specifications. It provides structured guidance, standardized patterns, and templates specifically designed to produce architecture documents, release notes, and technical specs with clarity and consistency.