How does it identify changes in the codebase?

It uses repository scanning commands like 'rg --files' and targeted file reads to compare the actual code structure against existing documentation sections.

How does it handle deprecated code?

Rather than simply deleting information, the skill is instructed to briefly note when a file or feature is deprecated or no longer in use.

Can it document UI flows and keybindings?

Yes, the skill is designed to update behavior summaries, including keybindings and UI flows, whenever the underlying implementation changes.

Which file does the Doc Maintainer skill update?

This skill specifically focuses on maintaining and expanding the single DOCS.MD file to serve as the central source of truth for the repository.

Does it create new documentation files?

No, the skill's rules explicitly state not to add unrelated documentation files, ensuring all relevant information remains centralized in DOCS.MD.

Scribe Doc Maintainer

Name: Scribe Doc Maintainer
Author: nibzard

bynibzard

•

Content Management

Maintains and synchronizes the central DOCS.MD file with the Scribe firmware codebase to ensure accurate technical documentation.

The Scribe Doc Maintainer skill is a specialized utility designed to manage the primary technical documentation for the Scribe firmware project. It streamlines the documentation process by scanning the repository for code changes, mapping new subsystems, and updating the central DOCS.MD file with concise, factual details. This skill is particularly useful for keeping architectural maps, subsystem responsibilities, and key file paths perfectly aligned with the actual implementation, preventing documentation rot as the firmware evolves and ensuring new contributors have an up-to-date roadmap of the project.

Key Features

01Automated repository scanning to detect new or modified modules and assets

02Change tracking for UI flows, keybindings, and deprecated components

03Subsystem mapping including responsibilities and key header/source files

046 GitHub stars

05Table of Contents synchronization for consistent navigation and structure

06Markdown formatting enforcement using bulleted lists and numbered headings

Use Cases

01Updating technical documentation after adding new firmware features or screens

02Auditing current documentation coverage against the physical repository structure

03Generating a comprehensive codebase map for onboarding new project contributors

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add nibzard/scribe doc-maintainer

For use in Claude.ai and ChatGPT

Download Skill