skills.rest
rafazsh
rafazshCOMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Create structured technical documentation and user guides for software products.

Updated Sep 6, 2024
Search Tags:#documentation#technical writing#readme#tutorial#api reference#user guides
One-click install
npx skills add https://github.com/rafazsh/dotfiles --skill technical-writer-rafazsh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/rafazsh/dotfiles/tree/main/apps/claude/skills/technical-writer
Command: npx skills add https://github.com/rafazsh/dotfiles --skill technical-writer-rafazsh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps transform complex technical information into clear, structured documentation that users can understand and follow.

Core Features & Use Cases

  • Documentation Creation: Produces README files, API references, tutorials, manuals, onboarding guides, and technical explanations.
  • Content Structuring: Applies user-centered writing principles, progressive disclosure, examples, troubleshooting sections, and consistent formatting.
  • Use Case: Create a complete README for a software project with installation steps, usage examples, configuration details, and troubleshooting guidance.

Quick Start

Use the technical-writer skill to create a user-friendly README for my software project.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I write a user-friendly README for my software project?▼

To write a user-friendly README, structure your technical documentation with clear installation steps, practical usage examples, configuration details, and troubleshooting guidance. Applying progressive disclosure principles ensures developers can quickly understand and integrate your software.

What is the best way to structure API references and developer tutorials?▼

The best way to structure API references and tutorials is to apply user-centered writing, consistent formatting standards, and progressive disclosure. This approach breaks down complex technical concepts into onboarding materials that developers can easily follow.

Can I generate architecture documentation and troubleshooting content for technical concepts?▼

Yes, you can generate architecture documentation and troubleshooting content. The skill transforms complex technical information into structured manuals and explanations, applying consistent formatting standards to ensure software products are clearly documented.

Does this technical writing approach work for onboarding materials and user guides?▼

Yes, this technical writing approach works for onboarding materials and user guides. It applies structured writing practices and practical examples to create documentation that users can understand and follow without prior specialized knowledge.

What should I include in software documentation to ensure clear technical explanations?▼

Software documentation should include progressive disclosure, practical examples, consistent formatting standards, and troubleshooting sections. These elements ensure technical explanations remain clear and user-friendly while addressing common implementation issues.

Related Skills

Explore More Content & Communication Skills→
snoodleboot-iosnoodleboot-io
2

architecture-documentation

Creates technical architecture documents from provided concepts and steps for architects.

Official
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
tianxiao1430-jpgtianxiao1430-jpg
17

vision-expert

Convert UI screenshots into production-ready code using zai-vision tools.

Community
Advanced
jeniferGoncalvesDaSilvaDevjeniferGoncalvesDaSilvaDev

copywriting

Write and improve marketing copy for headlines, product descriptions, and CTAs.

Community
Advanced