Skip to main content

doc-maintainer

Maintain and expand DOCS.MD to cover the full Scribe codebase. Use when asked to update documentation, add missing modules/flows, improve coverage maps, or align docs with code changes in this repo.

소스 정보

저장소
nibzard/scribe
최근 소스 활동
2026년 1월 29일 10:08
감지된 SKILL.md 언어
영어
스타
10
포크
0

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
name
doc-maintainer
description
Maintain and expand DOCS.MD to cover the full Scribe codebase. Use when asked to update documentation, add missing modules/flows, improve coverage maps, or align docs with code changes in this repo.
# Doc Maintainer ## Goal Keep `DOCS.MD` accurate, comprehensive, and aligned with the current codebase. ## Workflow 1. Scan the repo for new or changed areas (prefer `rg --files` + targeted file reads). 2. Compare code areas to `DOCS.MD` sections and the Table of Contents. 3. Add or update documentation so each major subsystem and user-facing flow is covered. 4. Keep changes concise, factual, and tied to the actual implementation. ## Coverage Rules - Ensure every top-level folder with code or assets is represented in `DOCS.MD`. - For each subsystem, list: - Responsibilities (1-3 bullets). - Key entry files (headers + sources). - If new developer sections are added, update the Table of Contents to include them. - Prefer a single “Codebase Map” section for breadth, and add focused sections only for complex features. ## DOCS.MD Style - Use short paragraphs and bullet lists; avoid long prose. - Keep headings numbered to match the Table of Contents. - Use inline code for file paths. - Mention specific files for claims; avoid vague wording like “some files.” ## When Updating After Code Changes - If a new service or screen is added, document it under the relevant subsystem. - If behavior changes (e.g., keybindings, UI flow), update both the behavior summary and key files. - If a file is deprecated or unused, note it briefly rather than deleting documentation. ## Do Not - Do not add unrelated documentation files; only update `DOCS.MD`. - Do not describe managed components in depth; note them at a high level.
GitHub에서 보기