autosnippet 3.3.2 → 3.3.3

package/skills/autosnippet-devdocs/SKILL.md

@@ -1,92 +1,87 @@
 ---
 name: autosnippet-devdocs
-description: Teaches the agent how to save development documents (architecture decisions, debug reports, design docs, research notes) to the AutoSnippet knowledge base using autosnippet_submit_knowledge with knowledgeType 'dev-document'. Use when the agent finishes analysis, debugging, design, or research and wants to persist the findings.
+description: Generate and publish project Wiki documentation using autosnippet_wiki MCP tool (plan → write → finalize). Use when user says "generate wiki/docs", "write documentation", or agent needs to produce structured project documentation from the knowledge base.
 ---
 
-# AutoSnippet — Save Development Documents
+# AutoSnippet — Wiki Documentation Generation
 
-This skill tells the agent how to **save development documents** (architecture decisions, debug reports, design docs, research notes) to the AutoSnippet knowledge base, so they can be retrieved by future sessions.
+This skill guides the agent through generating structured **Wiki documentation** from the AutoSnippet knowledge base using the `autosnippet_wiki` MCP tool.
 
 ## When to use this skill
 
-- After finishing a **debug/troubleshooting session** — save the root cause analysis
-- After making an **architecture or design decision** — save the ADR (Architecture Decision Record)
-- After completing a **research or investigation** — save findings and conclusions
-- After a **performance analysis** — save the benchmark results and optimization notes
-- When the user says "保存这个分析" / "记录一下" / "save this to KB"
+- User asks to **generate project documentation** or **wiki**
+- After a **cold-start bootstrap** completes — produce docs from newly captured knowledge
+- When the user says "generate docs" / "write wiki" / "create documentation"
+- After significant **knowledge base changes** — refresh documentation
 
-## MCP Tool
+## MCP Tools
 
-| Tool | Description |
-|------|-------------|
-| `autosnippet_submit_knowledge` | Unified knowledge submission. For documents, set item `knowledgeType: 'dev-document'` — only needs `title` + `markdown`. Auto-published, no review needed. |
-| `autosnippet_search` | Search saved documents by keyword or semantic query. |
+| Tool | Operation | Description |
+|------|-----------|-------------|
+| `autosnippet_wiki` | `plan` | Plan topics + data packages (returns topic list + per-topic data for writing) |
+| `autosnippet_wiki` | `finalize` | Complete generation (write meta.json, dedup check, validate completeness) |
+| `autosnippet_search` | — | Search knowledge for additional context during writing |
+| `autosnippet_knowledge` | `get` | Retrieve full Recipe content for reference |
 
-## How to save a document
+## Workflow
 
-Call `autosnippet_submit_knowledge` with an `items` array containing one document entry:
+### Step 1: Plan topics
 
 ```json
 {
-  "items": [{
-    "title": "BiliDemo 冷启动性能分析",
-    "markdown": "## 问题背景\n\n冷启动耗时 8s...\n\n## 根因分析\n\n...\n\n## 解决方案\n\n...",
-    "knowledgeType": "dev-document",
-    "description": "冷启动耗时 8s 的根因分析和优化方案",
-    "tags": ["debug-report", "performance"],
-    "scope": "project-specific"
-  }]
+  "operation": "plan",
+  "language": "en"
 }
 ```
 
-### Required fields
+Returns:
+- **topics[]** — Recommended documentation topics based on knowledge base content
+- **dataPackages** — Per-topic data bundles (related Recipes, code patterns, architecture info)
+- **sessionId** — Session identifier for the finalize step
 
-| Field | Description |
-|-------|-------------|
-| `title` | Document title (Chinese or English) |
-| `markdown` | Full Markdown content |
-
-### Optional fields
-
-| Field | Default | Description |
-|-------|---------|-------------|
-| `description` | `""` | One-line summary |
-| `tags` | `[]` | Labels for filtering: `adr`, `debug-report`, `design-doc`, `research`, `performance`, `refactoring` |
-| `scope` | `project-specific` | `universal` or `project-specific` |
+### Step 2: Write articles
 
-## Recommended tags
+For each topic in the plan:
+1. Read the **dataPackage** for that topic
+2. Write a well-structured Markdown article to the wiki directory (`AutoSnippet/wiki/`)
+3. Use Recipe content as source of truth — cite Recipe titles
+4. Follow the structure: Overview → Details → Code Examples → Related Topics
 
-| Tag | Use case |
-|-----|----------|
-| `adr` | Architecture Decision Record |
-| `debug-report` | Bug investigation / root cause analysis |
-| `design-doc` | Module/feature design document |
-| `research` | Technology research or investigation |
-| `performance` | Benchmark results, profiling analysis |
-| `refactoring` | Refactoring plan or post-mortem |
-| `migration` | Migration guide or plan |
-| `meeting-notes` | Technical meeting summary |
+### Step 3: Finalize
 
-## How documents are delivered to Cursor
-
-Documents are stored as `knowledgeType: 'dev-document'` in the knowledge DB. They follow a dedicated delivery path:
+```json
+{
+  "operation": "finalize",
+  "sessionId": "<from plan>",
+  "articlesWritten": ["AutoSnippet/wiki/topic-1.md", "AutoSnippet/wiki/topic-2.md"]
+}
+```
 
-1. **NOT compressed** into Cursor Rules (Channel A/B skip dev-documents)
-2. **Full text** written to `.cursor/skills/autosnippet-devdocs/references/*.md` (Channel D)
-3. **Searchable** via `autosnippet_search("your query")` — full-text search hits documents
+This triggers:
+- **meta.json** generation — topic index with cross-references
+- **Dedup check** — detect overlapping articles
+- **Completeness validation** — ensure all planned topics are covered
 
-## Document format tips
+## Writing guidelines
 
 - Use **clear headings** (`##`, `###`) — helps search and scanning
-- Include a **summary section** at the top
+- Include a **summary section** at the top of each article
 - Reference **file paths** and **class names** concretely — improves search relevance
-- For ADRs, use the structure: Context → Decision → Consequences
-- For debug reports: Symptom → Investigation → Root Cause → Fix
+- Cite **Recipe triggers** (e.g., `@bilidili-feature-url-routing`) as knowledge sources
+- For architecture docs: Context → Design → Implementation → Trade-offs
+- For pattern docs: When to Use → How to Use → Code Example → Anti-patterns
+
+## Language parameter
+
+| Value | Effect |
+|-------|--------|
+| `"en"` | English documentation (default) |
+| `"zh"` | Chinese documentation |
 
 ## Related Skills
 
 | Skill | When to use |
 |-------|-------------|
-| `autosnippet-create` | Saving **code patterns/recipes** (needs trigger, doClause, etc.) |
-| `autosnippet-devdocs` (this) | Saving **prose documents** (only needs title + markdown) |
-| `autosnippet-recipes` | Looking up existing knowledge |
+| `autosnippet-create` | Submitting **code patterns/recipes** to KB (not documents) |
+| `autosnippet-devdocs` (this) | Generating **Wiki documentation** from KB |
+| `autosnippet-recipes` | Looking up existing knowledge for reference |

package/templates/guard-ci.yml

@@ -1,8 +1,8 @@
 # AutoSnippet Guard CI/CD Check
 # Auto-generated by AutoSnippet. Do not edit manually.
-# 在 push 和 PR 时自动运行 Guard 合规检查
+# Automatically runs Guard compliance checks on push and PR.
 #
-# 使用方法：将此文件复制到项目的 .github/workflows/ 目录
+# Usage: Copy this file to your project's .github/workflows/ directory.
 
 name: AutoSnippet Guard Check
 

package/templates/recipes-setup/_template.md

@@ -1,42 +1,42 @@
 ---
-# 必填字段
+# Required Fields
 title: Your Recipe Title Here (English, ≤50 chars, verb-based)
 trigger: @my_trigger
 category: Network  # MUST be one of: View, Service, Tool, Model, Network, Storage, UI, Utility
 language: swift  # swift, objectivec, go, python, java, kotlin, javascript, typescript, dart, rust
-summary_cn: 中文概述，≤100 字，描述该 Recipe 的用途
+summary_cn: Chinese summary, ≤100 chars
 summary_en: English summary, ≤100 words
-headers: ["import Foundation"]  # 完整 import 语句数组
+headers: ["import Foundation"]  # Complete import statement array
 knowledgeType: code-pattern  # code-pattern, architecture, best-practice, code-standard, code-style, code-relation, data-flow, event-and-data-flow, module-dependency, boundary-constraint, solution, anti-pattern
 
-# V3 Cursor Delivery 必填字段
-kind: pattern  # rule = 强制约束 | pattern = 可复用模式 | fact = 项目事实
-doClause: "Use dependency injection via constructor"  # 英文祈使句，以动词开头，≤60 tokens
-dontClause: "Don't instantiate services with new directly"  # 英文反向约束
-whenClause: "When creating a new service class"  # 英文触发场景
+# V3 Cursor Delivery Required Fields
+kind: pattern  # rule = mandatory constraint | pattern = reusable pattern | fact = project fact
+doClause: "Use dependency injection via constructor"  # English imperative, verb-first, ≤60 tokens
+dontClause: "Don't instantiate services with new directly"  # English negative constraint
+whenClause: "When creating a new service class"  # English trigger scenario
 coreCode: |
   class MyService {
     constructor(private db: Database) {}
   }
 usageGuide: |
-  ### 何时使用
-  创建新 Service 类时
-  ### 规范
-  统一使用构造器注入
+  ### When to Use
+  When creating a new Service class
+  ### Convention
+  Always use constructor injection
 
-# 可选字段（推荐）
-keywords: ["关键词1", "关键词2", "关键词3"]
+# Optional Fields (recommended)
+keywords: ["keyword1", "keyword2", "keyword3"]
 tags: [tag1, tag2]
 whenToUse: |
-  - 适用场景 1
-  - 适用场景 2
-  - 适用场景 3
+  - Applicable scenario 1
+  - Applicable scenario 2
+  - Applicable scenario 3
 whenNotToUse: |
-  - 不应使用的场景 1
-  - 不应使用的场景 2
+  - Scenario to avoid 1
+  - Scenario to avoid 2
 difficulty: beginner  # beginner, intermediate, advanced
 authority: 1  # 1~5
-relatedRecipes: ["@相关Recipe的trigger"]
+relatedRecipes: ["@related_recipe_trigger"]
 version: "1.0.0"
 updatedAt: 1706515200
 author: team_name
@@ -46,38 +46,38 @@ deprecated: false
 ## Snippet / Code Reference
 
 ```
-// 在此粘贴或编写代码片段（建议可运行、含必要错误处理与注释）
+// Paste or write code snippet here (ideally runnable, with error handling and comments)
 ```
 
 ## AI Context / Usage Guide
 
-### 什么时候用
+### When to Use
 
-- 适用场景说明
-- 典型业务或技术情境
-- 典型使用者角色
+- Applicable scenario description
+- Typical business or technical context
+- Typical user role
 
-### 何时不用
+### When Not to Use
 
-- 排除场景、易误用情况
-- 何时应用替代方案
+- Exclusion scenarios, easy-to-misuse cases
+- When to apply alternatives
 
-### 使用步骤
+### Steps
 
-1. 第一步：准备或前置条件
-2. 第二步：主体逻辑
-3. 第三步：结果处理或后续
+1. Step 1: Preparation or prerequisites
+2. Step 2: Core logic
+3. Step 3: Result handling or follow-up
 
-### 关键点
+### Key Points
 
-- 易错点、容易忽略的细节
-- 线程/内存/生命周期约束
-- 性能特征或限制
+- Error-prone areas, easily overlooked details
+- Thread/memory/lifecycle constraints
+- Performance characteristics or limitations
 
-### 依赖与前置条件
+### Dependencies & Prerequisites
 
-- 需导入的模块/框架
-- 最低系统/API 版本
+- Required modules/frameworks to import
+- Minimum system/API version
 - 权限、配置或环境要求
 
 ### 错误处理