skills.rest
haotool
haotoolOFFICIAL
Explore all skills by this author →
GitHub

technical-writer

Generate structured technical documentation in Markdown or HTML for software products.

2|Updated Oct 12, 2025
Search Tags:#architecture#documentation#onboarding#tutorials#technical-writing#knowledge-base#user-guide
One-click install
npx skills add https://github.com/haotool/app --skill technical-writer-haotool
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/haotool/app/tree/main/.agents/skills/technical-writer
Command: npx skills add https://github.com/haotool/app --skill technical-writer-haotool

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often lags behind product releases, causing user confusion and longer onboarding. This Skill generates clear, structured technical documentation for diverse audiences.

Core Features & Use Cases

  • User guides: end-user manuals with step-by-step instructions.
  • Developer docs: API references, integration guides, and system architecture docs.
  • Onboarding & knowledge base: tutorials, SOPs, and knowledge articles for teams.
  • Use Case: Create a ready-to-publish document from a product spec or issue description.

Quick Start

Generate a complete technical document for the requested feature or system.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate technical documentation from a product spec?▼

To generate technical documentation from a product spec, input your feature description to automatically produce well-structured Markdown or HTML outputs, including audience-appropriate examples and troubleshooting sections.

What is the best way to create developer docs and API references?▼

The best way to create developer docs and API references is to use a documentation generator that applies clarity and accessibility guidelines, ensuring architecture references and integration guides are structured for technical audiences.

How do I write onboarding tutorials and knowledge base articles?▼

Writing onboarding tutorials and knowledge base articles involves structuring step-by-step instructions and SOPs, utilizing a technical writing tool to ensure the content is clear and accessible for both technical and non-technical team members.

Can I use this to create user guides for non-technical audiences?▼

Yes, you can use it to create user guides for non-technical audiences by generating end-user manuals with step-by-step instructions and audience-appropriate language, ensuring complex software features are easily understood.

Does the generated documentation include troubleshooting sections?▼

Yes, the generated documentation includes dedicated troubleshooting sections, automatically adding these parts to user guides and developer docs to address common issues and improve the onboarding experience.

Related Skills

Explore More Content & Communication Skills→
DayoptDayopt

docs

Generate technical documentation and ADRs from feature descriptions.

Official
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
jandan138jandan138

mermaid-diagram

Generate Mermaid diagrams from user requirements and verify syntax with Mermaid CLI.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate