Global AI chat room · 14 online now Join now
C
SKILL Listed

Codebase WIKI Documentation Skill

A drafting skill for preparing concise design-partner agreements between a technology startup and a potential client, clarifying intellectual property, data, domain expertise, scope and deliverables; have qualified counsel review before signing.

s-cellesGeneralGeneral
4.7Rating
97Uses
—Feedback
01 / SKILL INTRODUCTION

About this skill

A drafting skill for preparing concise design-partner agreements between a technology startup and a potential client, clarifying intellectual property, data, domain expertise, scope and deliverables; have qualified counsel review before signing.

TRIGGER DESCRIPTION

Use this skill when the user needs the workflow described above, especially when they want a structured result rather than a one-off answer. A drafting skill for preparing concise design-partner agreements between a technology startup and a potential client, clarifying intellectual property, data, domain expertise, scope and deliverables; have qualified counsel review before signing.

01Progressive disclosure

Load metadata first, then read the body and bundled resources when needed.

02Evaluable iteration

Use positive and negative tests plus user feedback to guide the next iteration.

03Clear output contract

Define inputs, outputs, dependencies and success criteria to reduce ambiguity.

02 / SKILL FILES

Skill files

SKILL.mdMarkdown · — · Previewable
---
name: codebase-wiki-documentation-skill
description: A skill for generating comprehensive WIKI.md documentation for codebases using the Language Server Protocol for precise analysis, ideal for documenting code structure and dependencies.
---

# Codebase WIKI Documentation Skill

Act as a Codebase Documentation Specialist. You are an expert in generating detailed WIKI.md documentation for various codebases using Language Server Protocol (LSP) for precise code analysis.

Your task is to:
- Analyze the provided codebase using LSP.
- Generate a comprehensive WIKI.md document.
- Include architectural diagrams, API references, and data flow documentation.

You will:
- Detect language from configuration files like `package.json`, `pyproject.toml`, `go.mod`, etc.
- Start the appropriate LSP server for the detected language.
- Query the LSP for symbols, references, types, and call hierarchy.
- If LSP unavailable, scripts fall back to AST/regex analysis.
- Use Mermaid diagrams extensively (f
This is an online preview. Copy it and continue editing in your local skill directory.
YAML FRONTMATTERSkill metadata
nameCodebase WIKI Documentation Skill
descriptionUse this skill when the user needs the workflow described above, especially when they want a structured result rather than a one-off answer. A drafting skill for preparing concise design-partner agreements between a technology startup and a potential client, clarifying intellectual property, data, domain expertise, scope and deliverables; have qualified counsel review before signing.
03 / WORKFLOW

How to use

  1. 01
    Step 1

    Read the trigger description and identify whether the task is about creation, evaluation or improvement.

  2. 02
    Step 2

    Open SKILL.md and confirm the input, output and bundled resource requirements.

  3. 03
    Step 3

    Run a small test set with realistic positive and negative prompts.

  4. 04
    Step 4

    Iterate on the description and instructions using feedback and evaluation results.

04 / DISCUSSIONS

Discussions and feedback

—feedback records

Use feedback to keep checking trigger quality, output consistency and maintenance status.

Back to skills
Email