skills.rest
rfdiosuao
rfdiosuaoCOMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Write API documentation, READMEs, ADRs, and developer onboarding materials.

30|7|Updated Mar 1, 2026
Search Tags:#documentation#technical writing#adr#readme#api reference#developer docs
One-click install
npx skills add https://github.com/rfdiosuao/openfang-cn --skill technical-writer-rfdiosuao
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/rfdiosuao/openfang-cn/tree/main/crates/openfang-skills/bundled/technical-writer
Command: npx skills add https://github.com/rfdiosuao/openfang-cn --skill technical-writer-rfdiosuao

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides expert technical writing services to create clear, precise, and developer-friendly documentation, improving the usability and maintainability of software projects.

Core Features & Use Cases

  • API Documentation: Generates comprehensive reference entries for APIs.
  • READMEs & ADRs: Crafts essential project overviews and decision records.
  • Developer Onboarding: Creates clear guides for new developers.
  • Use Case: A new open-source project needs a professional README, API reference, and contribution guidelines to attract and support developers. This Skill can generate all these essential documents following best practices.

Quick Start

Generate a README file for a new Rust project with sections for installation, usage, and contribution.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate API reference documentation for developers?▼

Generate API reference documentation by creating comprehensive reference entries that emphasize clarity, precision, and empathy for the developer audience. This ensures code examples are complete, runnable, and tested while maintaining consistent terminology throughout the API docs.

What is the Diataxis framework and when do I need it for technical writing?▼

The Diataxi framework is a structured approach to technical writing that categorizes content into tutorials, how-to guides, reference, and explanation. You need it when creating developer onboarding materials, README files, or ADRs to ensure documentation serves distinct user intents effectively.

How do I write an Architecture Decision Record for a software project?▼

Write an Architecture Decision Record (ADR) by crafting essential project decision records that follow best practices for clarity and precision. This technical writing process ensures architectural choices are documented consistently for developer audiences.

Can I use this to create README files and contribution guidelines for an open source project?▼

Yes, you can create README files and contribution guidelines for open source projects. This technical writing service crafts essential project overviews and onboarding materials to attract and support developers following established documentation frameworks.

What is the best way to ensure code examples in developer docs are runnable?▼

Ensure code examples in developer docs are runnable by generating complete and tested snippets during the technical writing process. This approach guarantees accuracy in API documentation and README files while maintaining empathy for the developer audience.

Related Skills

Explore More Software Engineering Skills→
andisabandisab

documentation

Generate technical documentation, API references, and README files from source code.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
RightNow-AIRightNow-AI
18.1k

technical-writer

Write API documentation, README files, and ADRs using the Diataxis framework.

Official
Intermediate
blaxel-aiblaxel-ai
25

update-api-reference

Regenerate OpenAPI reference documentation from Go swag annotations.

Official
Intermediate