akillness avatar

User Guide Writing

When you need to ship a getting-started guide, tutorial, how-to article, or FAQ for actual product users, this skill keeps you honest about scope and structure. It forces you to pick one primary mode upfront (getting-started, tutorial, how-to, FAQ, or release-help-update), gather real UI evidence instead of guessing, and emit the smallest artifact that solves the problem. The routing boundaries are tight: API docs go to api-documentation, internal specs go to technical-writing, and release notes go to changelog-maintenance. The Step 6 writing rules are opinionated in a good way: lead with the task, name prerequisites early, prefer observable actions, and put troubleshooting near the task instead of burying it. If you write user docs that drift into architecture explanations or try to be five document types at once, this will pull you back.

skills.sh installs
188
GitHub stars
22
last updated
Jun 3, 2026

Install

$ npx -y skills add akillness/oh-my-skills --skill user-guide-writing --agent claude-code

Installs into .claude/skills of the current project.

Files

When you need to ship a getting-started guide, tutorial, how-to article, or FAQ for actual product users, this skill keeps you honest about scope and structure. It forces you to pick one primary mode upfront (getting-started, tutorial, how-to, FAQ, or release-help-update), gather real UI evidence instead of guessing, and emit the smallest artifact that solves the problem. The routing boundaries are tight: API docs go to api-documentation, internal specs go to technical-writing, and release notes go to changelog-maintenance. The Step 6 writing rules are opinionated in a good way: lead with the task, name prerequisites early, prefer observable actions, and put troubleshooting near the task instead of burying it. If you write user docs that drift into architecture explanations or try to be five document types at once, this will pull you back.

Browse the repository on GitHub

Sponsors

Details

Repository
github.com/akillness/oh-my-skills
Category
Documentation
First seen
Jun 3, 2026

More from akillness/oh-my-skills

All 81
1absolutelyskilled avatartechnical-writingabsolutelyskilled/absolutelyskilledtechnical writing142skills.sh installs
2modelstudioai avatarbailian-docs-llm-wikimodelstudioai/skills阿里云百炼平台技术文档知识库(LLM Wiki)。当用户查询百炼模型列表、API 参数、错误码、 应用开发(智能体/RAG/知识库/记忆/插件)、模型对比与定价、SDK/OpenAI 兼容接口、 多模态能力(语音/图片/视频)、Token 计费等百炼相关问题时激活。 包含 models 结构化模型市场数据(含 cont2.1Kskills.sh installs
3sickn33 avatarcode-documentation-code-explainsickn33/antigravity-awesome-skillscode documentation code explain874skills.sh installs
4riba2534 avatarfeishu-cli-doc-guideriba2534/feishu-cli飞书文档 Markdown 编写规范,尤其是 Mermaid/PlantUML、Callout、表格、图片、公式等 导入兼容性检查。当用户要生成将导入飞书的 Markdown、排查 doc import 渲染失败、 或需要飞书兼容图表语法时使用。596skills.sh installs
5sickn33 avatardocumentation-generation-doc-generatesickn33/antigravity-awesome-skillsdocumentation generation doc generate528skills.sh installs
6sickn33 avatarcode-documentation-doc-generatesickn33/antigravity-awesome-skillscode documentation doc generate502skills.sh installs