skills.rest
RightNow-AI
RightNow-AIOFFICIAL
Explore all skills by this author →
Website𝕏@rightnowai_coGitHub

technical-writer

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

18.1k|2.3k|Updated Feb 24, 2026
Search Tags:#documentation#technical writing#adr#readme#api docs#developer documentation
One-click install
npx skills add https://github.com/RightNow-AI/openfang --skill technical-writer-rightnow-ai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/RightNow-AI/openfang/tree/main/crates/openfang-skills/bundled/technical-writer
Command: npx skills add https://github.com/RightNow-AI/openfang --skill technical-writer-rightnow-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating clear, precise, and developer-friendly documentation for software projects, ensuring better understanding and adoption.

Core Features & Use Cases

  • API Documentation: Generates detailed reference entries for endpoints and functions.
  • READMEs & ADRs: Structures project overviews, installation guides, and architectural decisions.
  • Use Case: A new feature is released, and this Skill can be used to generate a comprehensive README update, including API docs and a quick-start example, ensuring developers can immediately understand and use the new functionality.

Quick Start

Use the technical-writer skill to generate a README for a new Rust project.

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 documentation that developers can actually understand and use?▼

API documentation generated by this approach emphasizes clarity, precision, and developer empathy. It provides detailed reference entries for endpoints and functions while ensuring all code examples are runnable and terminology remains consistent.

What is the Diataxis framework and how does it structure developer documentation?▼

The Diataxis framework structures developer documentation by dividing it into tutorials, how-to guides, reference, and explanation. This Skill applies the framework to ensure documentation achieves better understanding and adoption across API docs, READMEs, and ADRs.

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

Writing an Architecture Decision Record (ADR) involves structuring your architectural decisions clearly. This Skill structures project overviews and architectural decisions, ensuring the rationale and context behind software choices are documented with precision.

What is the best way to create a README for a new Rust project?▼

The best way to create a README is to include a project overview, installation guide, and quick-start example. This Skill can generate a comprehensive README update for a new Rust project, ensuring developers can immediately understand and use the functionality.

Can I use this approach to document an existing API with inconsistent terminology?▼

Yes, you can use this approach to document an existing API because it explicitly ensures terminology is consistent across all generated documentation. It provides detailed reference entries for endpoints while maintaining clarity and precision.

Related Skills

Explore More Software Engineering Skills→
phuhao00phuhao00
12

code-analyst-agent

Analyze source code to identify symbols, call graphs, and architectural patterns.

Community
Intermediate
Lautaro073Lautaro073

api-reference-documentation

Generates endpoints, models, and authentication details from OpenAPI 3.0 documents into Markdown-ready content.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
jey3dayojey3dayo
6

markdown-docs

Review Markdown documentation for clarity, structure, and technical accuracy.

Community
Intermediate