doc-writer

Generate French user documentation articles from doc_sitemap.json.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/Swear4/agent_rules --skill doc-writer-swear4
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/Swear4/agent_rules/tree/main/agent-universal/skills/doc-writer
Command: npx skills add https://github.com/Swear4/agent_rules --skill doc-writer-swear4

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

doc-writer automates the creation of French user documentation from a sitemap, eliminating the manual writing bottlenecks and ensuring consistent structure and tone across articles.

Core Features & Use Cases

  • Batch article generation: Produce complete FR articles for multiple sitemap entries in one run.
  • Type-safe formatting: Enforces the required structure per article type (reference, guide, concept, troubleshooting, tutorial, quickstart, playbook) and strict i18n label usage.
  • Quality guarantees: Ensures minimum content length for reference articles (45+ lines) and mandatory FAQ sections.

Quick Start

Run the doc-writer to generate all planned FR articles from doc_sitemap.json and place the resulting .fr.md files in .agent/workspace/docs/fr.

Frequently Asked Questions about doc-writer

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

FAQPage Schema
How do I automate French documentation generation from a sitemap?

You can automate French documentation generation by running a pipeline that reads doc_sitemap.json and batch produces structured .fr.md articles with enforced i18n labels and type-specific formatting rules.

What is the best way to enforce minimum length and FAQ sections in markdown documentation?

Enforce minimum length and FAQ sections in markdown documentation by applying type-specific content rules during generation, such as requiring 45+ lines for reference articles and at least two FAQs per article.

Does automated documentation generation support different article types like guides, tutorials, and troubleshooting?

Automated documentation generation supports multiple article types including reference, guide, concept, troubleshooting, tutorial, quickstart, and playbook, enforcing the required structure and strict i18n label usage for each type.

How do I batch produce i18n markdown articles across multiple sitemap entries?

Batch produce i18n markdown articles by processing all planned sitemap entries in a single run, generating complete French content files with consistent tone, structure, and default values placed in the designated workspace directory.

Can I regenerate a single French documentation article to add more depth without rewriting everything?

You can regenerate a single French documentation article to add depth while maintaining the same type-specific structure, i18n label usage, and mandatory content rules enforced by the generation pipeline.

What are the limitations of automating content generation from a sitemap for French docs?

Limitations of automating French docs from a sitemap include strict dependency on the doc_sitemap.json structure for input, mandatory adherence to predefined article type formats, and enforced minimum content lengths that may not fit all contexts.