بنقرة واحدة
kn-doc
Use when working with Knowns documentation - viewing, searching, creating, or updating docs
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
Use when working with Knowns documentation - viewing, searching, creating, or updating docs
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Use when orchestrating a full Knowns spec or task wave through planning, implementation, review, integration, and verification, optionally using sub-agents when scopes are parallel-safe.
Use when you need to understand existing code, find patterns, search project knowledge, use web research for external/current facts, or explore a large codebase before implementation
Use when committing code changes with proper conventional commit format and verification
Use when extracting reusable patterns, decisions, failures, or knowledge into documentation
Use only when the user explicitly wants the legacy no-review-gates pipeline for an approved spec; prefer kn-flow for normal spec orchestration
Use when implementing a task - follow the plan, check ACs, track progress
| name | kn-doc |
| description | Use when working with Knowns documentation - viewing, searching, creating, or updating docs |
Announce: "Using kn-doc to work with documentation."
Core principle: SEARCH BEFORE CREATING - avoid duplicates.
// List docs
mcp_knowns_docs({ "action": "list" })
// View doc (smart mode)
mcp_knowns_docs({ "action": "get", "path": "<path>", "smart": true })
// Search docs
mcp_knowns_search({ "action": "search", "query": "<query>", "type": "doc" })
// Create doc (MUST include description)
mcp_knowns_docs({ "action": "create", "title": "<title>",
"description": "<brief description of what this doc covers>",
"tags": ["tag1", "tag2"],
"folder": "folder"
})
// Update content
mcp_knowns_docs({ "action": "update", "path": "<path>",
"content": "content"
})
// Update metadata (title, description, tags)
mcp_knowns_docs({ "action": "update", "path": "<path>",
"title": "New Title",
"description": "Updated description",
"tags": ["new", "tags"]
})
// Update section only
mcp_knowns_docs({ "action": "update", "path": "<path>",
"section": "2",
"content": "## 2. New Content\n\n..."
})
| Type | Folder |
|---|---|
| Core | (root) |
| Guide | guides |
| Pattern | patterns |
| API | api |
CRITICAL: Always include description - validate will fail without it!
Section edit is most efficient:
mcp_knowns_docs({ "action": "update", "path": "<path>",
"section": "3",
"content": "## 3. New Content\n\n..."
})
CRITICAL: After creating/updating docs, validate:
// Validate specific doc (saves tokens)
mcp_knowns_validate({ "entity": "<doc-path>" })
// Or validate all docs
mcp_knowns_validate({ "scope": "docs" })
If errors found, fix before continuing.
All built-in skills in scope must end with the same user-facing information order: kn-init, kn-spec, kn-flow, kn-plan, kn-research, kn-implement, kn-verify, kn-doc, kn-template, kn-extract, and kn-commit.
Required order for the final user-facing response:
Keep this concise for CLI use. Documentation-specific content may extend the key-details section, but must not replace or reorder the shared structure.
Out of scope: explaining, syncing, or generating .claude/skills/*. Runtime auto-sync already handles platform copies, so this skill source only defines the built-in output contract.
For kn-doc, the key details should cover:
When doc work naturally leads to another action, include the best next command. If the request ends with inspection or a fully validated update, do not force a handoff.
WebUI supports mermaid rendering. Use for:
```mermaid
graph TD
A[Start] --> B{Decision}
B -->|Yes| C[Action]
B -->|No| D[End]
```
Diagrams render automatically in WebUI preview.
@doc/<path>