SuperAPI AI Directory

wiki-code

Writing & research

View repository

Updated 10-15 21:37

About this skill

wiki-code — Code Project Wiki Management Skill

Treat the codebase and project documentation as Raw Source .wiki/ Manage the layers. Do not guess and open files directly; find the location with qmd, then read only the necessary original text.

Prerequisites

  • The current working directory must be the code project root
  • First qmd status와 qmd collection listto check the current status and whether the collection is registered
  • Use the qmd CLI as the primary path, and if MCP is available, use it as a search aid
  • Do not assume a fixed MCP server name; use only the tools actually exposed in the current session
  • qmd search Use only the URIs that come out as results, and do not construct paths by guessing by hand
  • In this repository, docs, skills, agents.md use the actual index path such as
  • The project must be registered as a collection in qmd
    qmd status
    qmd collection list
    
  • If not registered, register first:
    qmd collection add . --name 프로젝트명 --mask "**/*.{md,ts}"
    qmd update && qmd embed
    

Wiki location

[프로젝트 루트]/
├── .wiki/                    ← LLM이 소유·관리하는 위키 레이어
│   ├── WIKI-AGENTS.md        ← 운영 규칙 (세션 시작 시 먼저 읽기)
│   ├── wiki-index.md         ← 전체 위키 카탈로그
│   ├── wiki-log.md           ← 작업 타임라인 (append-only)
│   ├── concepts/             ← 아키텍처 패턴·도메인 개념
│   ├── entities/             ← 모듈·서비스·컴포넌트·문서 페이지
│   ├── synthesis/            ← 데이터 흐름·의사결정·트레이드오프
│   └── diagrams/             ← Mermaid 다이어그램 (.md)
└── (소스 코드/문서 — 읽기 전용 Raw Source)

.gitignore에 .wiki/ Whether to add it is decided by a human. Track it when sharing with the team; ignore it for personal use.


INIT — First time only

.wiki/WIKI-AGENTS.mdRun when there is no .

  1. Understand the project structure:
    qmd search "readme" -c 프로젝트명
    qmd search "workflow" -c 프로젝트명
    
  2. .wiki/ Create the folder and substructure
  3. WIKI-AGENTS.md Create (based on this skill's content, filling in project name and path)
  4. wiki-index.md, wiki-log.md Initialize
  5. Create project overview page: .wiki/entities/project-overview.md
  6. Confirm the first ingest area with a human

INGEST — Code/docs → add to wiki

Trigger: "add to wiki", "document it", mention of a file/module

  1. Understand the source — search related docs and skills with qmd:
    qmd search "기능 또는 문서명" -c 프로젝트명
    
    Only the actual URIs from the search results qmd getput into . The representative root is skills/.../skill.md, docs/..., agents.md
  2. Check the summary — 3–5 lines on features, interfaces, and dependencies, then human confirmation
  3. Create/update entities/ page
  4. Update concepts/ — reflect architecture patterns and workflow concepts
  5. Create diagrams/ (if needed) — visualize the flow with Mermaid
  6. Update wiki-index.md + Record in wiki-log.md

Page format

---
tags: [wiki, entities|concepts|synthesis|diagrams]
created: YYYY-MM-DD
updated: YYYY-MM-DD
sources: [소스 파일 경로]
related_files: [직접 연관된 문서/스킬 파일]
---

# 문서/스킬명
> 한 줄 요약

## 역할
## 주요 인터페이스
## 의존성
## 데이터 흐름
## 연결된 위키 페이지
- [[관련 페이지]]
## 원본 소스
- `skills/.../skill.md`
- `docs/...`
- `agents.md`

QUERY — Answer structural questions

Trigger: "How does it work?", "Explain the flow of ~", "What is the relationship between ~ and ~?"

  1. wiki-index.md Read → identify related pages
  2. Read related wiki pages
  3. If needed, reference actual docs/skills with qmd:
    qmd search "질문 내용" -c 프로젝트명
    
  4. Answer with citations (source: file path + line number)
  5. Valuable answer → .wiki/synthesis/YYYY-MM-DD-주제.md Suggest saving

DRIFT — Detect changes and update the wiki

Trigger: "update the wiki", "reflect the changes"

  1. git diff --name-only Extract changed files with
  2. of changed files related_filesSearch wiki pages with
  3. Update that wiki page
  4. Automatically suggest INGEST when a new document/skill is detected

LINT — Wiki check

Trigger: "wiki check", "lint", "document consistency check"

Check items

  1. Drift detection: compare git log vs wiki updated dates
  2. Orphan pages: pages not in wiki-index.md
  3. Broken source links: whether deleted files are referenced
  4. Contradictions: different descriptions for the same document/skill
  5. Undocumented items: items present in qmd but with no wiki page

qmd collection management commands

# 현재 프로젝트 등록
qmd collection add . --name 프로젝트명 --mask "**/*.{md,ts}"

# 컨텍스트 설명 추가
qmd context add qmd://프로젝트명/ "프로젝트 한 줄 설명"
qmd context add qmd://프로젝트명/docs/ "프로젝트 문서"
qmd context add qmd://프로젝트명/skills/ "프로젝트 스킬"

# 인덱스 갱신
qmd update

# 하이브리드 검색
qmd query "워크플로우" -c 프로젝트명

# 특정 파일 읽기: qmd search 결과 URI를 그대로 사용

Current session example

In this repository, peach-harness collection and qmd://peach-harness/ prefix are used.

qmd search "peach-setup-harness" -c peach-harness
qmd get qmd://peach-harness/skills/peach-setup-harness/skill.md
qmd get qmd://peach-harness/docs/03-워크플로우.md
qmd get qmd://peach-harness/agents.md

Core principles

  • Never modify source code — read only (Raw Source)
  • .wiki/ Write only under
  • Drift detection: always run DRIFT or LINT after code changes
  • qmd CLI is the default entry point: if MCP is available, use it only as a search aid
  • Language: Korean (keep code and technical terms in English)
  • Diagrams: always visualize complex flows with Mermaid