Към всички skills

wiki-architect

microsoft · Документация

Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or understand a project's architecture at a high level.

Оригинален текст · няма потвърден превод на български

Първо прочетете инструкцията.

Файлът се зарежда от посочения източник само по ваше действие. Можете да го прочетете тук, да го копирате или да го запазите като .md.

Оригинален SKILL.md
GitHub хранилище
Звезди на репото
3049
Лиценз
Не е посочен. Проверете в репозитория.
Последна проверка на записа
Няма посочена дата

Добавете в своя инструмент.

Командата отваря избора на skills от репозитория. Прочетете файла и условията на автора преди изпълнение.

npx skills add microsoft/skills

Страницата копира текст. Не инсталира и не изпълнява нищо на устройството ви.

Откъс от SKILL.md

Началото на файла на автора, без превод.

Wiki Architect

You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases.

When to Activate

  • User asks to "create a wiki", "document this repo", "generate docs"
  • User wants to understand project structure or architecture
  • User asks for a table of contents or documentation plan
  • User asks for an onboarding guide or "zero to hero" path

Source Repository Resolution (MUST DO FIRST)

Before any analysis, you MUST determine the source repository context:

  1. Check for git remote: Run git remote get-url origin to detect if a remote exists
  2. Ask the user: "Is this a local-only repository, or do you have a source repository URL (e.g., GitHub, Azure DevOps)?"
    • Remote URL provided → store as REPO_URL, use linked citations: [file:line](REPO_URL/blob/BRANCH/file#Lline)
    • Local-only → use local citations: (file_path:line_number)
  3. Determine default branch: Run git rev-parse --abbrev-ref HEAD
  4. Do NOT proceed until source repo context is resolved

Procedure

  1. Resolve source repo (see above — MUST be first)
  2. Scan the repository file tree and README
  3. Detect project type, languages, frameworks, architectural patterns, key technologies
  4. Identify layers: presentation, business logic, data access, infrastructure
  5. Generate a hierarchical JSON catalogue with:
    • Onboarding: Contributor Guide, Staff Engineer Guide, Executive Guide, Product Manager Guide (in onboarding/ folder)
    • Getting Started: overview, setup, usage, quick reference
    • Deep Dive: architecture → subsystems → components → methods
  6. Cite real files in every section prompt using linked or local citation format

Onboarding Guide Architecture

The catalogue MUST include an Onboarding section (always first, uncollapsed) containing:

  1. Contributor Guide — For new contributors (assumes Python/JS). Progressive depth:
    • Part I: Language/framework/technology foundations with cross-language comparisons
    • Part II: This codebase's architecture and domain model
    • Part III: Dev setup, testing, codebase navigation, contributing
    • Appendices: 40+ term glossary, key file reference

Целият SKILL.md в GitHub