archflow-agent-doc-writer

Writes API reference, onboarding guides, and README documentation for software projects.

28|4|Updated Mar 12, 2026
One-click install
npx skills add https://github.com/AZidan/archflow --skill archflow-agent-doc-writer-azidan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: archflow-agent-doc-writer
Source: https://github.com/AZidan/archflow/tree/main/adapters/generic/.agents/skills/archflow-agent-doc-writer
Command: npx skills add https://github.com/AZidan/archflow --skill archflow-agent-doc-writer-azidan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Software projects often ship with missing, outdated, or inconsistent documentation, leaving developers without clear onboarding paths, API references, or README guidance. ## Core Features & Use Cases - API Reference Documentation: Documents endpoints, HTTP methods, parameters, authentication, error codes, and runnable examples in docs/api-reference.md. - Onboarding Guides: Creates step-by-step setup instructions, architecture explanations, and troubleshooting sections in docs/ONBOARDING_GUIDE.md. - README Authoring: Produces project overviews with installation, quick start, and contribution guidance at the repository root. - Use Case: After your backend team finalizes an API contract, delegate to this role to produce the human-facing API guide and onboarding docs that link back to the contract without duplicating its schema. ## Quick Start Ask the agent to act as the doc-writer role and generate the API reference, onboarding guide, and README for the current repository.

Frequently Asked Questions about archflow-agent-doc-writer

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

FAQPage Schema
How do I generate API documentation from my codebase?

Delegate to the doc-writer role, which analyzes the codebase and writes docs/api-reference.md covering endpoints, HTTP methods, parameters, authentication, error codes, and code examples. It links back to the API contract rather than restating schemas.

What files does the doc-writer role create?

It creates docs/api-reference.md for the human-facing API guide, docs/ONBOARDING_GUIDE.md for developer setup, and README.md at the repository root. All output goes to a docs subfolder except the README.

Can the doc-writer edit the API contract?

No. The API contract is owned exclusively by the api-contract-architect role. The doc-writer documents the layer around it, such as getting-started guides and examples, and reports disagreements between contract and code instead of documenting around them.

How does the doc-writer handle information it cannot verify?

It marks anything it could not verify as UNVERIFIED rather than asserting it works. This applies to untested setup steps, ambiguous requirements, or claims that cannot be confirmed against the codebase.

When is the doc-writer role triggered in Archflow?

It is an on-demand role, since no Archflow phase currently dispatches it automatically. You invoke it explicitly when a phase or skill delegates documentation work to this role.