technical-writer

Generate user-friendly documentation, API references, guides, and technical content.

1|Updated Feb 10, 2026
One-click install
npx skills add https://github.com/fefogarcia/approved-skills --skill technical-writer-fefogarcia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/fefogarcia/approved-skills/tree/main/skills/technical-writer
Command: npx skills add https://github.com/fefogarcia/approved-skills --skill technical-writer-fefogarcia

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users create high-quality, clear, and user-friendly technical documentation, ensuring complex information is easily understood by its intended audience.

Core Features & Use Cases

  • Documentation Generation: Assists in writing API references, README files, tutorials, and user guides.
  • Content Structuring: Provides templates and best practices for organizing technical content effectively.
  • Style Guidance: Offers advice on tone, voice, and formatting for clarity and scannability.
  • Use Case: When you need to document a new software feature, create a README for a project, or write a tutorial for a complex process.

Quick Start

Use the technical writer skill to generate a README file for a Python CLI tool that sorts files by size.

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 README file for a software project?

To write a README file, you should structure the content using user-centered design principles, ensuring complex information is easily understood by developers and users. This skill applies structured writing practices to generate clear, scannable project documentation.

What is the best way to document an API reference?

Documenting an API reference requires applying structured writing principles and user-centered design to generate clear technical content. This approach ensures the API documentation is formatted for clarity and scannability, making complex endpoints easy for developers to understand.

How do I create a user guide for technical software?

Creating a user guide involves generating user-friendly technical content with structured writing principles and scannable content formatting. This skill helps organize technical concepts clearly, ensuring the guide effectively explains complex processes to the intended audience.

Can I use this to write tutorials for complex technical processes?

Yes, you can generate tutorials for complex technical processes by utilizing structured writing principles and user-centered design. This skill provides style guidance on tone and formatting to ensure the tutorial content is clear, scannable, and easily understood by users.

Does this approach help structure technical documentation for developers?

Yes, structuring technical documentation for developers is supported through templates and best practices for organizing technical content effectively. It applies scannable content formatting and style guidance to ensure the documentation is clear and user-friendly.