스킬 shirushi

🏷️

shirushi

Name: shirushi
Author: CAPHTECH

안전 🌐 네트워크 접근⚙️ 외부 명령어

Управление идентификаторами документов в Git-репозиториях

Идентификаторы документов становятся несовместимыми при параллельной работе команд. Shirushi проверяет, назначает и отслеживает неизменяемые doc_id в файлах Markdown и YAML с интеграцией CI. Это предотвращает подделку идентификаторов и обеспечивает отслеживаемость документов на протяжении всего жизненного цикла проекта.

지원: Claude Codex Code(CC)

📊 69 적절함

스킬 ZIP 다운로드

Claude에서 업로드

설정 → 기능 → 스킬 → 스킬 업로드로 이동

토글을 켜고 사용 시작

테스트해 보기

"shirushi" 사용 중입니다. Run shirushi lint to validate documents

예상 결과:

✓ PCE-SPEC-2025-0001-G - API Specification (valid)
✓ PCE-ADR-2025-0012-A - Architecture Decision Record (valid)
✗ API-SPEC-2025-0042-B - Invalid checksum (expected G)
⚠ PCE-SPEC-2025-0001-G referenced by 3 files has changed

"shirushi" 사용 중입니다. Run shirushi scan --format table

예상 결과:

PCE-SPEC-2025-0001-G | API Specification | spec | 2025-01-15
PCE-ADR-2025-0012-A | Architecture Decision Record | adr | 2025-01-14
PCE-DOC-2025-0023-C | User Guide | guide | 2025-01-13

보안 감사

안전

v5 • 1/16/2026

This skill contains ONLY documentation (SKILL.md). The static scanner produced 37 false positives by misidentifying markdown code formatting and configuration examples as security threats. No executable code, network calls, or malicious patterns exist. All findings are dismissed as FALSE_POSITIVE.

스캔된 파일

176

분석된 줄 수

발견 사항

총 감사 수

위험 요인

🌐 네트워크 접근 (1)

skill-report.json:6

⚙️ 외부 명령어 (21)

감사자: claude 감사 이력 보기 →

품질 점수

아키텍처

100

유지보수성

콘텐츠

커뮤니티

100

보안

사양 준수

만들 수 있는 것

Обеспечение стандартов идентификаторов

Поддержание согласованных идентификаторов документов в большой базе документации с автоматической проверкой

Добавление проверки CI

Интеграция проверок идентификаторов документов в рабочие процессы pull request для предотвращения слияния несовместимых идентификаторов

Отслеживание связей между документами

Мониторинг влияния изменений документов на связанные документы и обнаружение нарушенных перекрёстных ссылок

이 프롬프트를 사용해 보세요

Проверка всех документов

Run shirushi lint to validate all document IDs in this repository

Обнаружение недавних изменений

Run shirushi lint --base HEAD~1 to detect which documents have changed

Назначение нового идентификатора документа

Use shirushi assign docs/new-spec.md to generate a doc_id for this new document

Список всех отслеживаемых документов

Run shirushi scan --format table to list all tracked documents with their metadata

모범 사례

Run shirushi lint before every commit to catch issues early
Configure .shirushi.yml once and commit it to version control
Use shirushi scan regularly to maintain an accurate document inventory

피하기

Modifying doc_id manually without using shirushi assign
Skipping lint checks before committing documentation changes
Using different ID formats across different project directories

자주 묻는 질문

Какие форматы документов поддерживает shirushi?

Shirushi supports Markdown and YAML files that include YAML frontmatter with a doc_id field.

Можно ли настроить формат идентификатора?

Yes. Configure id_format and dimensions in .shirushi.yml using enum, year, serial, and checksum types.

Работает ли shirushi с любым CI-провайдером?

Yes. Run shirushi lint --base as a CI step. It returns non-zero exit codes on validation failures.

Отправляется ли содержимое документов куда-либо?

No. Shirushi runs locally. Content hashes are computed but no document content leaves your machine.

Что происходит при переименовании документа?

Document renames are detected as changes. Use shirushi lint --base to review impact on referenced documents.

Чем shirushi отличается от других инструментов документации?

Shirushi focuses specifically on ID integrity and cross-reference tracking, not content generation or formatting.

개발자 세부 정보

작성자

CAPHTECH

라이선스

MIT

리포지토리

https://github.com/CAPHTECH/shirushi/tree/main/skills/shirushi

참조

main

파일 구조

📄 SKILL.md