update-docs

Synchronize documentation pages with updated specs via the Step 6 pipeline.

43|1|Updated Feb 19, 2024
One-click install
npx skills add https://github.com/dogganidhal/noddde --skill update-docs-dogganidhal
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/dogganidhal/noddde/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/dogganidhal/noddde --skill update-docs-dogganidhal

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts after spec or implementation changes. This skill coordinates the end-to-end process to keep docs synchronized with the latest specs, APIs, and behavioral notes.

Core Features & Use Cases

  • Orchestrates the Step 6 documentation update pipeline after a spec change.
  • Identifies affected pages via frontmatter, references, and API mappings, then updates code examples and explanations.
  • Updates llms.txt, API reference pages, and produces a concise update report.

Quick Start

Run this skill after a spec update to synchronize documentation pages with the latest API and behavioral changes.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I synchronize documentation pages with updated specs?

You can synchronize documentation with updated specs by orchestrating the Step 6 pipeline, which identifies affected pages via frontmatter and API mappings to update code examples and explanations automatically.

Why does documentation drift after spec or implementation changes?

Documentation drifts because spec updates are rarely propagated manually to all dependent pages. This skill coordinates the end-to-end process to keep docs synchronized with the latest APIs, specs, and behavioral notes.

How do I update API reference materials and llms.txt after a spec change?

To update API references and llms.txt after a spec change, run this skill to enforce llms.txt integrity, map spec exports to pages, and validate updates across docs and change logs.

Can I track behavioral requirements and migrations across documentation?

Yes, you can track behavioral requirements and migrations by enforcing input sources from frontmatter, which allows the documentation update pipeline to validate and report updates accurately.

What is the best way to automate code example updates in documentation?

The best way to automate code example updates is by using a documentation pipeline that identifies affected pages through references and frontmatter, then updates the examples and explanations directly.

Does this documentation pipeline work without external dependencies?

Yes, this documentation synchronization skill operates without external dependencies, using internal frontmatter and API mappings to validate and report updates across your documentation ecosystem.