dsh-skill-function-extraction

Readme

# Function Extraction

[![skills.sh](https://skills.sh/b/addxing/function-extraction)](https://skills.sh/addxing/function-extraction)

A skill for extracting a complete feature implementation chain from a codebase and generating a technical development document with business logic, data flow, exception handling, and Mermaid diagrams. Works with any AI coding agent.

## Install

```bash
npx skills add addxing/function-extraction
```

### DeepSeek Harness

This repo follows the DeepSeek Harness (DSH) Skill format. Clone it into a skills directory and it will be auto-discovered:

```bash
# User-level install (available in all projects)
git clone https://github.com/addxing/function-extraction ~/.dsh/skills/function-extraction

# Project-level install (current project only)
git clone https://github.com/addxing/function-extraction .dsh/skills/function-extraction
```

DSH hot-reloads the skills directory after cloning; the skill becomes available in new sessions.

Or install it as an official bundle plugin in one line (requires pnpm; restart the web app afterwards):

```bash
dsh plugin --profile web add "github:addxing/function-extraction#main"
```


## Usage

After installing the skill, ask your AI agent to use it when you need a feature-level implementation document:

```text
Use $function-extraction to document the login flow implementation.
```

For best results, provide:

- the feature name
- the entry file, class, method, route, page, button text, or other clues
- the expected output language or documentation scope, if different from the default

If the entry point is missing, the skill guides the agent to search the codebase and ask you to confirm the correct entry before continuing.

## What It Does

This skill guides an agent to:

- confirm the target feature and entry point
- trace the implementation from entry to completion
- identify key business logic, data flow, state changes, and exception handling
- generate a technical development document using `template.md`
- include Mermaid flowcharts, sequence diagrams, and dependency graphs when useful

## Files

- `SKILL.md` - the skill instructions
- `template.md` - the output document template
- `LICENSE.txt` - Apache 2.0 license

## Chinese Documentation

See [README.zh.md](README.zh.md).