スキル一覧に戻る
KnellBalm

docs-professional

by KnellBalm

QueryCraft Service URL

0🍴 0📅 2026年1月24日
GitHubで見るManusで実行

SKILL.md


name: docs-professional description: 전문적이고 고품질인 프로젝트 문서를 작성하고 유지 관리합니다. 새로운 기능을 문서화하거나 기존 위키를 업데이트할 때 사용합니다.

Docs Professional

QueryCraft 프로젝트의 지식 베이스를 전문적으로 관리하고 고품질의 문서를 작성하기 위한 지침입니다.

Instructions

  1. 지식 베이스 구조 준수:

    • 비즈니스/기능적 내용은 REFERENCE_WIKI.md에 추가합니다.
    • 기술/아키텍처/배포관련 내용은 TECH_WIKI.md에 추가합니다.
    • 새로운 내용은 관련 있는 섹션을 찾아 통합하며, 중복 문서를 만들지 않습니다.
  2. 전문적인 글쓰기 톤앤매너:

    • 객관적이고 명확한 기술적 용어를 사용합니다. (한글을 기본으로 하되, 기술 용어는 영어 병기 권장)
    • 사용자가 읽었을 때 바로 따라 할 수 있는 '실행 가능한(Actionable)' 정보를 제공합니다.
    • [!IMPORTANT], [!TIP] 등 마크다운 얼럿을 활용하여 중요 정보를 강조합니다.
  3. 시각화 요소 활용:

    • 복잡한 흐름은 mermaid 다이어그램을 사용하여 시각화합니다.
    • 코드 예시는 최신 구현 상태를 반영하여 정확하게 작성합니다.
  4. 문서 검증:

    • 작성 후 데드 링크가 없는지, 마크다운 렌더링이 깨지지 않는지 확인합니다.
    • 최신 코드와 문서 사이에 괴리가 없는지 대조합니다.

Best Practices

  • 리빙 도큐먼트 (Living Document): 코드가 바뀌면 문서도 즉시 바뀝니다. "나중에 해야지"는 없습니다.
  • 아카이빙: 유효하지 않은 정보는 삭제하기보다 docs/archive/로 이동시켜 히스토리를 보존합니다.
  • 중복 배제: 동일한 정보를 여러 곳에 적지 말고, 한 곳에 적은 뒤 링크를 활용하세요.

スコア

総合スコア

50/100

リポジトリの品質指標に基づく評価

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

レビュー

💬

レビュー機能は近日公開予定です