模极社社区 - 制造业全产业链交流平台

    • 登录
    • 版块
    • 最新
    • 话题
    • 热门
    • 用户
    • 群组

    Skill Template——模具行业从业者必备知识手册

    社区公告
    1
    1
    0
    正在加载更多帖子
    • 从旧到新
    • 从新到旧
    • 最多赞同
    回复
    • 在新帖中回复
    登录后回复
    此主题已被删除。只有拥有主题管理权限的用户可以查看。
    • S
      system 2 最后由 编辑

      <h2>Skill Template</h2>

      <p>Template for creating skills extracted from learnings. Copy and customize.</p>

      <hr>

      <h3>SKILL.md Template</h3>

      <pre><code>

      name: skill-name-here
      description: "Concise description of when and why to use this skill. Include trigger conditions."

      Skill Name

      Brief introduction explaining the problem this skill solves and its origin.

      Quick Reference

      Situation Action
      [Trigger 1] [Action 1]
      [Trigger 2] [Action 2]

      Background

      Why this knowledge matters. What problems it prevents. Context from the original learning.

      Solution

      Step-by-Step

      1. First step with code or command
      2. Second step
      3. Verification step

      Code Example

      ```language
      // Example code demonstrating the solution
      ```

      Common Variations

      • Variation A: Description and how to handle
      • Variation B: Description and how to handle

      Gotchas

      • Warning or common mistake #1
      • Warning or common mistake #2

      Related

      • Link to related documentation
      • Link to related skill

      Source

      Extracted from learning entry.

      • Learning ID: LRN-YYYYMMDD-XXX
      • Original Category: correction | insight | knowledge_gap | best_practice
      • Extraction Date: YYYY-MM-DD
        </code></pre>

      <hr>

      <h3>Minimal Template</h3>

      <p>For simple skills that don't need all sections:</p>

      <pre><code>

      name: skill-name-here
      description: "What this skill does and when to use it."

      Skill Name

      [Problem statement in one sentence]

      Solution

      [Direct solution with code/commands]

      Source

      • Learning ID: LRN-YYYYMMDD-XXX
        </code></pre>

      <hr>

      <h3>Template with Scripts</h3>

      <p>For skills that include executable helpers:</p>

      <pre><code>

      name: skill-name-here
      description: "What this skill does and when to use it."

      Skill Name

      [Introduction]

      Quick Reference

      Command Purpose
      ./scripts/helper.sh [What it does]
      ./scripts/validate.sh [What it does]

      Usage

      Automated (Recommended)

      ```bash
      ./skills/skill-name/scripts/helper.sh [args]
      ```

      Manual Steps

      1. Step one
      2. Step two

      Scripts

      Script Description
      scripts/helper.sh Main utility
      scripts/validate.sh Validation checker

      Source

      • Learning ID: LRN-YYYYMMDD-XXX
        </code></pre>

      <hr>

      <h3>Naming Conventions</h3>

      <ul>
      <li><strong>Skill name</strong>: lowercase, hyphens for spaces</li>
      <li>Good: <code>docker-m1-fixes</code>, <code>api-timeout-patterns</code></li>
      <li>Bad: <code>Docker_M1_Fixes</code>, <code>APITimeoutPatterns</code></li>
      </ul>

      <ul>
      <li><strong>Description</strong>: Start with action verb, mention trigger</li>
      <li>Good: "Handles Docker build failures on Apple Silicon. Use when builds fail with platform mismatch."</li>
      <li>Bad: "Docker stuff"</li>
      </ul>

      <ul>
      <li><strong>Files</strong>:</li>
      <li><code>SKILL.md</code> - Required, main documentation</li>
      <li><code>scripts/</code> - Optional, executable code</li>
      <li><code>references/</code> - Optional, detailed docs</li>
      <li><code>assets/</code> - Optional, templates</li>
      </ul>

      <hr>

      <h3>Extraction Checklist</h3>

      <p>Before creating a skill from a learning:</p>

      <ul>

      Learning is verified (status: resolved)</li>

      Solution is broadly applicable (not one-off)</li>

      Content is complete (has all needed context)</li>

      Name follows conventions</li>

      Description is concise but informative</li>

      Quick Reference table is actionable</li>

      Code examples are tested</li>

      Source learning ID is recorded</li>

      </ul>

      <p>After creating:</p>

      <ul>

      Update original learning with <code>promoted_to_skill</code> status</li>

      Add <code>Skill-Path: skills/skill-name</code> to learning metadata</li>

      Test skill by reading it in a fresh session</li>

      </ul>

      <hr>

      <p>本文由模极社发布</p>

      <hr>
      <p>!<a href="upload://im5w4bbZS7qEfHo32U8caxAUX72.svg">Skill Template</a></p>

      <hr>
      <h4>🔗 你</h4>

      <hr>
      <p>你在实际生产中遇到过类似问题吗?欢迎留言讨论。</p>

      1 条回复 最后回复 回复 引用 0
      • First post
        Last post
      Powered by NodeBB | Contributors