Can it generate new documentation from scratch?

Yes, the 'generation' category allows the skill to map your project's code structure to a new documentation outline using symbol overviews.

Does this skill work with BMAD workflows?

No, if a BMAD workflow is detected, the skill will guide you to use the specialized BMAD tech-writer agent instead to avoid workflow conflicts.

What is the 'accuracy-first' principle in update-docs?

It is a requirement that every factual claim in the documentation, such as port numbers or file paths, must be verified against the actual source code before the documentation is updated.

How do I start a documentation update?

Simply invoke the skill with /update-docs followed by a description of the change or a specific GitHub issue number.

What configuration files are required?

The skill requires a .rawgentic_workspace.json in the root and a .rawgentic.json within the project directory to resolve paths and capabilities.

Documentation Sync & Update

Name: Documentation Sync & Update
Author: 3D-Stories

by3D-Stories

•

Content Management

Synchronizes, creates, or restructures project documentation by verifying all factual claims against the live codebase.

The update-docs skill implements the Rawgentic WF7 workflow, a rigorous 10-step process designed to eliminate documentation rot and ensure technical accuracy. By enforcing an 'accuracy-first' principle, the skill cross-references every file path, port number, and command syntax mentioned in your docs against the actual source code using Serena MCP symbols. Whether you are performing a simple correction, a full documentation restructure, or generating new guides from scratch, this skill manages the entire lifecycle from audit to conventional commit Pull Request.

Key Features

01Project-Aware Drafting: Utilizes .rawgentic.json configuration for deep context and consistency.

02Automatic PR Generation: Creates documentation branches and pushes changes using conventional commits.

03WF7 10-Step Workflow: Provides a structured path from scope validation to PR creation.

04Automated Documentation Audit: Scans existing files for gaps, inaccuracies, and outdated information.

052 GitHub stars

06Accuracy-First Verification: Validates all technical claims (ports, paths, syntax) against source code.

Use Cases

01Generating architectural documentation by analyzing project symbols and directory structures.

02Updating API references and setup guides after a major code refactor.

03Auditing existing documentation to fix 'stale' information that no longer matches the codebase.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add 3d-stories/rawgentic update-docs

For use in Claude.ai and ChatGPT