skills.rest
openJiuwen-ai
openJiuwen-aiOFFICIAL
Explore all skills by this author →
WebsiteGitHub

doc-update

Audit project documentation against source code and report multilingual gaps.

2.5k|422|Updated Mar 5, 2026
Search Tags:#documentation#code audit#configuration verification#multilingual alignment#CLI accuracy#structural consistency#changelog-free docs
One-click install
npx skills add https://github.com/openJiuwen-ai/jiuwenswarm --skill doc-update-openjiuwen-ai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-update
Source: https://github.com/openJiuwen-ai/jiuwenswarm/tree/main/jiuwenswarm/resources/agent/workspace/skills/doc-update
Command: npx skills add https://github.com/openJiuwen-ai/jiuwenswarm --skill doc-update-openjiuwen-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill fixes outdated or inconsistent project documentation by treating the source code as the only source of truth and systematically reconciling all docs (including multilingual versions).

Core Features & Use Cases

  • Source-code-first auditing: Verifies defaults, enums, flag lists, constants, and configuration tables directly against the implementation.
  • Multilingual 1:1 alignment: Ensures each language’s documentation is fully paired; reports gaps instead of inventing missing content.
  • Structural correctness: Maintains continuous chapter numbering, removes stale version tags, and checks cross-references and link targets.

Quick Start

Ask the agent to update the documentation by running a doc audit for the JiuwenSwarm project.

Frequently Asked Questions about doc-update

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

FAQPage Schema
How do I update project documentation to match the source code?▼

You update project documentation to match source code by running a doc audit that validates defaults, enums, and configuration tables directly against the implementation. This ensures all docs reflect the source-code truth.

What is the best way to ensure multilingual documentation alignment?▼

The best way to ensure multilingual documentation alignment is systematic cross-language pairing that reports gaps instead of inventing missing content. This maintains a strict 1:1 ratio across all supported language versions.

How do I audit CLI command accuracy in my technical docs?▼

You audit CLI command accuracy by validating flag lists and command configurations directly against the source-code truth. This verifies that documented commands match the actual implementation without stale tags.

Can I fix structural inconsistencies like broken cross-references without adding changelog tags?▼

Yes, you can fix structural inconsistencies by applying precise structural repairs that maintain continuous chapter numbering and remove stale version tags. This checks cross-references and link targets without adding changelogs.

What are the limitations of automated code audit for documentation?▼

Limitations include requiring a controlled reading scope of 1–3 files per pass to ensure accuracy. The process reports missing multilingual gaps rather than automatically inventing the missing content.

Related Skills

Explore More Software Engineering Skills→
anderssonqanderssonq
1

nvsinner-config-catalog

Catalog NvSinner configuration values and source file locations.

Community
Advanced
AJBcodingAJBcoding
4

moai-docs-linting

Lint Markdown documentation for formatting, broken references, and structural issues.

Community
Advanced
cwijayasundaracwijayasundara
3

harness-core

Automate build, test, deployment, and code review in CI/CD pipelines.

Community
Advanced
ChegginCheggin
1

documentation-generator

Generate API references, user guides, and changelogs from code and git history.

Community
Advanced