project-wiki

ProjectWiki - Project documentation assistant for developers

Task objectives

ProjectWiki is a documentation assistant for developers, technical leads, and project managers, helping quickly create and maintain high-quality project documentation.

Core value:

🚀 Fast generation: Generate standard documents such as README and ARCHITECTURE within 3 minutes
📋 Rich templates: 20+ standard templates, covering basic documents, architecture design, requirements documents, and workflows
🔧 Complete tooling: Interactive generator + configuration files, improving efficiency
📚 Practical knowledge: Quick reference for technical frameworks, design patterns, and best practices
✅ Quality assurance: Document consistency checks + standardized workflows, ensuring quality

Quick start (3 minutes)

Step 1: Prepare the configuration file

cat > config.yaml << EOF
project_name: "My Project"
username: "octocat"
version: "1.0.0"
description: "项目描述"
EOF

Step 2: Generate the README document

uv run python scripts/generate_doc.py \
  --template basic/README.md \
  --output README.md \
  --config config.yaml

Step 3: Generate the architecture document

uv run python scripts/generate_doc.py \
  --template architecture/ARCHITECTURE.md \
  --output ARCHITECTURE.md \
  --config config.yaml

Done! Now you have two standard documents.

Core capabilities

1. Template + script generation ⭐⭐⭐⭐⭐

Trigger scenarios: New project kickoff, need to quickly generate standard documents

Input: Basic information such as project name and author (can be provided via configuration file)

Output: Markdown documents in standard format

Supported templates:

Basic documents: README.md, CHANGELOG.md, CONTRIBUTING.md, LICENSE.md
Architecture documents: ARCHITECTURE.md, api-template.md, design-doc-template.md
Requirements documents: functional-doc-template.md, requirement-doc-template.md, rtm-template.md
Planning documents: ROADMAP.md, version-entry-template.md

Example:

# 使用配置文件
uv run python scripts/generate_doc.py \
  --template architecture/ARCHITECTURE.md \
  --output ARCHITECTURE.md \
  --config config.yaml

2. Document process management ⭐⭐⭐⭐

Trigger scenarios: Document lifecycle management, version releases, requirements changes

Core functions:

Document generation: Generate standard documents from templates
Consistency check: Check document consistency before version release
Change synchronization: Synchronously update related documents after requirements changes
Health check: Regularly assess document quality and completeness

Check items: Terminology naming, content logic, format structure, data parameters, chart text, role permissions, time schedule

Example:

# 版本发布前检查版本号一致性
grep "version:" SKILL.md
grep "## \[" CHANGELOG.md
cat templates/checklists/document-review-checklist.md

3. Knowledge base query ⭐⭐⭐

Trigger scenarios: Technology selection, architecture design, need best practice references

Knowledge base content:

Technical frameworks: frameworks.md - React, Vue, Angular, Spring Boot, etc.
Design patterns: patterns.md - Quick reference for 23 design patterns
Design principles: principles.md - Principles such as SOLID, DRY, KISS
Consistency rules: consistency-rules.md - Document consistency specifications

Example:

# 查询 React 框架信息
cat references/knowledge/frameworks.md | grep -A 10 "React"

Usage examples

Scenario 1: New project kickoff

cat > config.yaml << EOF
project_name: "Awesome Project"
username: "your-username"
version: "1.0.0"
description: "一个很棒的项目"
EOF

# 批量生成文档
uv run python scripts/generate_doc.py -t basic/README.md -o README.md -c config.yaml
uv run python scripts/generate_doc.py -t basic/CHANGELOG.md -o CHANGELOG.md -c config.yaml
uv run python scripts/generate_doc.py -t architecture/ARCHITECTURE.md -o ARCHITECTURE.md -c config.yaml

Verification result: ✅ 3 standard documents have been generated

Scenario 2: Generate API documentation

uv run python scripts/generate_doc.py \
  --template architecture/api-template.md \
  --output wiki/api.md \
  --config config.yaml

Fill in variables: api_name (required), endpoint (required), method (required)

Verification result: ✅ API documentation generated

Scenario 3: Pre-release check

# 检查版本号
grep "version:" SKILL.md
grep "## \[" CHANGELOG.md
git tag -l

# 使用检查清单
cat templates/checklists/document-review-checklist.md

Check result: ✅ All check items passed

Scenario 4: Technology selection inquiry

# 查询框架和模式
cat references/knowledge/frameworks.md
cat references/knowledge/patterns.md
cat references/knowledge/principles.md

Check result: ✅ Obtained the required information

Scenario 5: Batch generation script

#!/bin/bash
CONFIG="config.yaml"
GENERATOR="scripts/generate_doc.py"

uv run python $GENERATOR -t basic/README.md -o README.md -c $CONFIG
uv run python $GENERATOR -t basic/CHANGELOG.md -o CHANGELOG.md -c $CONFIG
uv run python $GENERATOR -t architecture/ARCHITECTURE.md -o ARCHITECTURE.md -c $CONFIG

echo "✅ 所有文档已生成"

Scenario 6: Use a standardized workflow

# 1. 使用任务执行模板
cat templates/checklists/task-execution-template.md

# 2. 按照 WORKFLOW.md 执行任务
cat WORKFLOW.md

# 3. 执行质量检查
markdownlint *.md
markdown-link-check README.md

# 4. 组织评审
cat templates/checklists/document-review-checklist.md

# 5. 生成验收报告
cat templates/checklists/acceptance-report-template.md

Check result: ✅ Standardized task execution, controllable quality

Workflow

3-step quick workflow:

1. 选择模板 → 2. 填写变量 → 3. 生成文档

Detailed workflow:

Select a template: Select an appropriate template based on the project type and documentation needs
Prepare configuration: Create a configuration file or fill in variables interactively
Generate documentation: Run the generator to generate standard documentation
Check and verify: Run consistency checks to ensure documentation quality

Reference documentation

High-frequency use

Documentation	Purpose	Path
Quick start	Get started in 3 minutes	QUICKSTART.md
User guide	Detailed instructions	scripts/README.md
Template index	View all templates	templates/

Medium-frequency use

Documentation	Purpose	Path
Basic documentation guide	Writing README, etc.	guides/basic-docs-checklist.md
Architecture documentation guide	Writing ARCHITECTURE	guides/architecture-doc-guide.md
Documentation management guide	Establishing management processes	guides/document-management-guide.md

Knowledge base

Documentation	Purpose	Path
Technology frameworks	Framework quick reference	knowledge/frameworks.md
Design patterns	Pattern quick reference	knowledge/patterns.md
Design principles	Principle quick reference	knowledge/principles.md
Consistency rules	Check specifications	knowledge/consistency-rules.md

Frequently asked questions (FAQ)

Q1: Can't find a template?

A: Use the --list command to view all available templates:

uv run python scripts/generate_doc.py --list

Q2: Configuration file not taking effect?

A: Check:

Whether the configuration file format is correct (YAML/JSON)
Whether the variable names match those in the template
Use the --config parameter to specify the correct path

Q3: Variables not replaced?

A: Ensure the variable format is correct:{{variable_name}}(note the double braces)

Q4: How to generate documentation in batches?

A: Create a batch generation script (see Scenario 5), or use a configuration file to generate them in sequence.

Q5: How to update generated documentation?

A: Edit the generated file directly, or rerun the generator (it will prompt to overwrite).

Q6: Which configuration file formats are supported?

A: YAML and JSON formats are supported. For examples, see config.example.yaml。

Notes

Use the generator: Prefer using generate_doc.py for quick generation
Standardization first: Use a unified variable format {{variable_name}}
Progressive refinement: Start with core documentation and gradually improve it
Maintain consistency: Ensure terminology, versions, and configurations are consistent across documents
Update promptly: Update documentation in sync with code changes
Verify regularly: Perform consistency checks before version releases

Command Quick Reference

# 列出模板
uv run python scripts/generate_doc.py --list

# 生成单个文档
uv run python scripts/generate_doc.py -t basic/README.md -o README.md

# 使用配置文件
uv run python scripts/generate_doc.py -t basic/README.md -o README.md -c config.yaml

# 标准化模板变量
uv run python scripts/normalize_templates.py --templates-dir templates

Template Quick Reference

Category	Template	Purpose
Basic	basic/README.md	Project Description
Basic	basic/CHANGELOG.md	Changelog
Architecture	architecture/ARCHITECTURE.md	System Architecture
Architecture	architecture/api-template.md	API Documentation
Requirements	requirements/functional-doc-template.md	Functional Requirements
Planning	roadmap/ROADMAP.md	Project Roadmap

Variable Format

{{variable_name}} - Regular variable
{{*variable_name}} - Required variable
{{?variable_name}} - Optional variable

Last Updated: 2026-03-13
Version: v8.0.0
Status: ✅ Available

About this skill

Task objectives

Quick start (3 minutes)

Step 1: Prepare the configuration file

Step 2: Generate the README document

Step 3: Generate the architecture document

Core capabilities

1. Template + script generation ⭐⭐⭐⭐⭐

2. Document process management ⭐⭐⭐⭐

3. Knowledge base query ⭐⭐⭐

Usage examples

Scenario 1: New project kickoff

Scenario 2: Generate API documentation

Scenario 3: Pre-release check

Scenario 4: Technology selection inquiry

Scenario 5: Batch generation script

Scenario 6: Use a standardized workflow

Workflow

Reference documentation

High-frequency use

Medium-frequency use

Knowledge base

Frequently asked questions (FAQ)

Q1: Can't find a template?

Q2: Configuration file not taking effect?

Q3: Variables not replaced?

Q4: How to generate documentation in batches?

Q5: How to update generated documentation?

Q6: Which configuration file formats are supported?

Notes

Command Quick Reference

Template Quick Reference

Variable Format