write-docs

Generate Markdown documentation from requirements files with inline citations.

1|Updated Oct 18, 2025
One-click install
npx skills add https://github.com/furiosa-ai/agent_skills --skill write-docs-furiosa-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/furiosa-ai/agent_skills/tree/main/write-docs
Command: npx skills add https://github.com/furiosa-ai/agent_skills --skill write-docs-furiosa-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the generation of documentation from a requirements file, ensuring traceable accuracy and inline sources.

Core Features & Use Cases

  • Reads docs/doc-requirements.md produced by the prepare-docs skill to drive documentation generation.
  • Generates publication-ready Markdown with per-sentence accuracy tracking and mandatory inline citations.
  • Enforces rationale blocks for statements with accuracy below 70% and supports multi-source synthesis.
  • Validates and preserves source links, documents contradictions with explicit notes, and supports multiple document types (API Reference, System Overview, Tutorial).

Quick Start

Generate documentation from docs/doc-requirements.md with per-sentence accuracy and inline citations.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I automate documentation generation from a requirements file?

You can automate documentation generation by reading a requirements file to produce publication-ready Markdown with per-sentence accuracy tracking and inline source citations. The process requires no user interaction and outputs API Reference, System Overview, and Tutorial documents.

How does per-sentence accuracy tracking work for generated Markdown documents?

Per-sentence accuracy tracking evaluates the confidence of each generated statement. It enforces rationale blocks for statements with accuracy below 70% and documents contradictions with explicit notes, ensuring traceable documentation.

What's the best way to ensure inline citations and rationale in technical documentation?

The best way to ensure inline citations and rationale is to automate documentation generation from a requirements file. This approach validates and preserves source links, enforces rationale for low-confidence statements, and supports multi-source synthesis.

Can I generate API Reference and Tutorial documents without manual user interaction?

Yes, you can generate API Reference, System Overview, and Tutorial documents automatically without user interaction. The automation consumes a requirements file and outputs publication-ready Markdown with verified links and inline citations.

How do I handle contradictions and low-confidence statements in automated documentation?

To handle contradictions and low-confidence statements, the documentation automation process documents contradictions with explicit notes. It also enforces mandatory rationale blocks for any statements with accuracy below 70%.

What format do I need to prepare before automating docs with inline citations?

You need to prepare a requirements file in Markdown format at a specific path. This requirements file drives the generation of publication-ready Markdown with mandatory inline citations and accuracy tracking.