← スキル一覧に戻る

knownsdoc
by knowns-dev
knownsdocは、other分野における実用的なスキルです。複雑な課題への対応力を強化し、業務効率と成果の質を改善します。
⭐ 66🍴 13📅 2026年1月23日
SKILL.md
name: knowns.doc description: Use when working with Knowns documentation - viewing, searching, creating, or updating docs
Working with Documentation
Navigate, create, and update Knowns project documentation.
Announce at start: "I'm using the knowns.doc skill to work with documentation."
Core principle: SEARCH BEFORE CREATING - avoid duplicates.
Quick Reference
# List all docs
knowns doc list --plain
# View doc (auto-handles large docs)
knowns doc "<path>" --plain --smart
# Search docs
knowns search "<query>" --type doc --plain
# Create doc
knowns doc create "<title>" -d "<description>" -t "tags" -f "folder"
# Update doc
knowns doc edit "<path>" -c "content" # Replace
knowns doc edit "<path>" -a "content" # Append
knowns doc edit "<path>" --section "2" -c "content" # Section only
Reading Documents
Always use --smart flag:
knowns doc "<path>" --plain --smart
- Small doc (≤2000 tokens) → full content
- Large doc → stats + TOC, then use
--section
Creating Documents
Step 1: Search First
knowns search "<topic>" --type doc --plain
Don't duplicate. Update existing docs when possible.
Step 2: Choose Location
| Doc Type | Location | Flag |
|---|---|---|
| Core (README, ARCH) | Root | No -f |
| Guide | guides/ | -f "guides" |
| Pattern | patterns/ | -f "patterns" |
| API doc | api/ | -f "api" |
Step 3: Create
knowns doc create "<title>" \
-d "<brief description>" \
-t "tag1,tag2" \
-f "folder" # optional
Step 4: Add Content
knowns doc edit "<path>" -c "$(cat <<'EOF'
# Title
## 1. Overview
What this doc covers.
## 2. Details
Main content.
## 3. Examples
Practical examples.
EOF
)"
Updating Documents
View First
knowns doc "<path>" --plain --smart
knowns doc "<path>" --toc --plain # For large docs
Update Methods
| Method | Command | Use When |
|---|---|---|
| Replace all | -c "content" | Rewriting entire doc |
| Append | -a "content" | Adding to end |
| Section edit | --section "2" -c "content" | Updating one section |
Section edit is most efficient - less context, safer.
# Update just section 3
knowns doc edit "<path>" --section "3" -c "## 3. New Content
Updated section content..."
Document Structure
Use numbered headings for --section to work:
# Title (H1 - only one)
## 1. Overview
...
## 2. Installation
...
## 3. Configuration
...
Remember
- Search before creating (avoid duplicates)
- Always use
--smartwhen reading - Use
--sectionfor targeted edits - Use numbered headings
- Reference docs with
@doc/<path>
スコア
総合スコア
75/100
リポジトリの品質指標に基づく評価
✓SKILL.md
SKILL.mdファイルが含まれている
+20
✓LICENSE
ライセンスが設定されている
+10
✓説明文
100文字以上の説明がある
+10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
✓フォーク
10回以上フォークされている
+5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
レビュー
💬
レビュー機能は近日公開予定です