doc-writer

Verify source code and write bilingual documentation for the Relax framework.

566|137|Updated Apr 13, 2026
One-click install
npx skills add https://github.com/redai-infra/Relax --skill doc-writer-redai-infra
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/redai-infra/Relax/tree/main/skills/doc-writer
Command: npx skills add https://github.com/redai-infra/Relax --skill doc-writer-redai-infra

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation and verification of bilingual documentation for the Relax project, ensuring correctness and consistency across English and Chinese versions.

Core Features & Use Cases

  • Content Verification: Cross-checks source code and documentation to ensure accuracy of APIs, classes, functions, and configurations.
  • Bilingual Maintenance: Creates and synchronizes English and Chinese documentation, maintaining parity in content and structure.
  • Use Case: When updating a feature in the codebase, automatically regenerate and verify both language versions of the guide to reflect current implementation details.

Quick Start

Document the 'PDF Text Extraction' module by creating bilingual guides with verified accuracy from source code and integrate these into the project's docs.

Frequently Asked Questions about doc-writer

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

FAQPage Schema
How do I ensure my bilingual documentation matches the current source code implementation?

To ensure bilingual documentation matches source code, verify source code signatures, import paths, and repo paths against the guides. This cross-checking process maintains API consistency and reduces technical discrepancies across English and Chinese versions.

What is the best way to synchronize English and Chinese markdown documentation for a framework?

The best way to synchronize English and Chinese markdown documentation is by using automated content verification. This process cross-checks APIs, classes, and configurations to maintain structural parity and content accuracy across both language versions.

Can I automatically verify API signatures against my existing documentation?

Yes, you can automatically verify API signatures against existing documentation. The system cross-checks source code signatures and import paths to ensure your technical guides accurately reflect the current codebase implementation without manual review.

How do I document a new module feature with verified accuracy from source code?

To document a new module feature with verified accuracy, extract implementation details directly from the source code and generate bilingual guides. This ensures the documentation reflects current configurations and functions, reducing technical discrepancies.

Why does my bilingual API documentation have technical discrepancies with the codebase?

Bilingual API documentation has technical discrepancies with the codebase when updates are not synchronized. Without verifying source code signatures, import paths, and repo paths, guides fail to reflect the current implementation accurately.