docs

Update or create Shift subsystem DOCS.md files with verified symbols and links.

217|7|Updated Dec 9, 2024
One-click install
npx skills add https://github.com/shift-editor/shift --skill docs-shift-editor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/shift-editor/shift/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/shift-editor/shift --skill docs-shift-editor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Outdated or missing subsystem documentation wastes contributor time and causes repeated mistakes that code review can’t prevent, especially when important constraints are not obvious from source.

Core Features & Use Cases

  • Updates existing DOCS.md for Shift subsystems to reflect real architectural and behavioral changes.
  • Creates DOCS.md when needed to document new or newly clarified modules, following the required section structure and boundaries.
  • Improves agent reliability by writing invariants, codemaps, key types, and verification steps that capture knowledge invisible in code.

Quick Start

Ask your AI to update the relevant Shift subsystem documentation by refreshing or creating the appropriate DOCS.md file using the required section order.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I keep subsystem documentation accurate after architectural changes?

You can create DODS.md files for new modules following the canonical section structure to document invariants, codemaps, key types, and verification steps, capturing architectural knowledge invisible in source code.

How do I document architecture invariants for developer onboarding?

Document architecture invariants for developer onboarding by writing them into DOCS.md files, capturing constraints and verification steps that prevent repeated mistakes code review cannot catch.

When should I update technical writing for subsystem changes?

You should update technical writing for subsystem changes during doc refresh requests, subsystem-wide modifications, and post-feature updates where invariants and workflow knowledge must be synchronized.

How do I verify symbol and link correctness in open source documentation?

Verify symbol and link correctness in open source documentation by running the docs context-drift check script, ensuring references remain valid and respect scope boundaries within the subsystem.

Do I need a specific framework to maintain DOCS.md files?

No specific framework is required to maintain DOCS.md files; you only need to follow the canonical DOCS.md structure, respect scope boundaries, and run the docs context-drift check script.