Skip to content

Commit ad69531

Browse files
Clarify skill and intermediate artifact docs
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
1 parent 2ab4736 commit ad69531

File tree

4 files changed

+37
-16
lines changed

4 files changed

+37
-16
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ Once that information is materialized as Skills, it can be consumed directly by
4545

4646
It covers the full chain from repository scanning, structural analysis, Skill planning, and document generation to tool-specific rule adaptation. It also supports incremental regeneration so Skills can stay aligned as the repository evolves.
4747

48+
In product terms, the final deliverable is the Skill layer itself. Generated Skills under `skills/` and the tool-specific files published by `adapt` are the end product. Blueprints, plans, reports, references, and state snapshots remain explicit intermediate artifacts that support review, debugging, and CI-safe refresh.
49+
4850
For one-off local analysis, `code2skill` can scan an entire repository and generate the full result set.
4951
For ongoing development workflows, it can combine historical state and code diffs to rebuild only the affected Skills, reducing repeated generation cost and making CI-based updates practical.
5052

@@ -94,13 +96,15 @@ This is not the final architecture destination, but it is a meaningful step upwa
9496

9597
From one Python repository, `code2skill` can produce:
9698

97-
- `project-summary.md` for a human-readable repository overview
98-
- `skill-blueprint.json` for the Phase 1 structural blueprint
99-
- `skill-plan.json` for the LLM-planned skill set
100-
- `skills/index.md` and `skills/*.md` for grounded AI-consumable skill documents
101-
- `AGENTS.md`, `CLAUDE.md`, `.cursor/rules/*`, `.github/copilot-instructions.md`, and `.windsurfrules` via `adapt`
102-
- `report.json` for execution metrics, token estimates, and impact summaries
103-
- `state/analysis-state.json` for incremental CI reuse
99+
- final Skill products
100+
- `skills/index.md` and `skills/*.md` for grounded AI-consumable skill documents
101+
- `AGENTS.md`, `CLAUDE.md`, `.cursor/rules/*`, `.github/copilot-instructions.md`, and `.windsurfrules` via `adapt`
102+
- intermediate artifacts
103+
- `project-summary.md` for a human-readable repository overview
104+
- `skill-blueprint.json` for the Phase 1 structural blueprint
105+
- `skill-plan.json` for the LLM-planned skill set
106+
- `report.json` for execution metrics, token estimates, and impact summaries
107+
- `state/analysis-state.json` for incremental CI reuse
104108

105109
## The Role Of Skills In A Repository
106110

README.zh-CN.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ Skill 可以表达例如以下信息:
4545

4646
它覆盖从仓库扫描、结构分析、Skill 规划、文档生成到工具规则适配的完整链路,也支持增量重建,让 Skill 能随着仓库演进保持同步。
4747

48+
从产品语义上说,最终交付物是 Skill 层本身。`skills/` 下生成的 Skill 文档,以及通过 `adapt` 发布到目标工具位置的规则文件,才是最终产物;blueprint、plan、report、references、state 则是支撑审阅、调试和 CI 增量刷新的中间工件。
49+
4850
对于一次性的本地分析,`code2skill` 可以扫描整个仓库并生成完整结果。对于持续开发场景,它可以结合历史 state 和代码 diff,只重建受影响的 Skill,降低重复生成成本,让 CI 内自动更新成为可行方案。
4951

5052
## 它保证什么
@@ -93,13 +95,15 @@ Skill 可以表达例如以下信息:
9395

9496
针对一个 Python 仓库,`code2skill` 可以产出:
9597

96-
- `project-summary.md`:面向人的仓库概览
97-
- `skill-blueprint.json`:Phase 1 的结构蓝图
98-
- `skill-plan.json`:LLM 规划出的 Skill 列表
99-
- `skills/index.md``skills/*.md`:供 AI 直接消费的 Skill 文档
100-
- 通过 `adapt` 生成 `AGENTS.md``CLAUDE.md``.cursor/rules/*``.github/copilot-instructions.md``.windsurfrules`
101-
- `report.json`:执行指标、token 估算和影响摘要
102-
- `state/analysis-state.json`:供增量 CI 复用的状态快照
98+
- 最终 Skill 产物
99+
- `skills/index.md``skills/*.md`:供 AI 直接消费的 Skill 文档
100+
- 通过 `adapt` 生成 `AGENTS.md``CLAUDE.md``.cursor/rules/*``.github/copilot-instructions.md``.windsurfrules`
101+
- 中间工件
102+
- `project-summary.md`:面向人的仓库概览
103+
- `skill-blueprint.json`:Phase 1 的结构蓝图
104+
- `skill-plan.json`:LLM 规划出的 Skill 列表
105+
- `report.json`:执行指标、token 估算和影响摘要
106+
- `state/analysis-state.json`:供增量 CI 复用的状态快照
103107

104108
## Skill 在仓库中的角色
105109

docs/output-layout.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ By default, `code2skill` writes artifacts under `.code2skill/` inside the target
44

55
This directory is the default artifact bundle root for the repository workflow. It groups the structural analysis outputs, planning outputs, generated Skills, diagnostics, and incremental state under one predictable location.
66

7+
Within this bundle, `code2skill` treats generated Skills as the final product layer. The other files remain important, but they are intermediate artifacts that support generation, review, reporting, and incremental CI refresh.
8+
79
```text
810
.code2skill/
911
project-summary.md
@@ -24,14 +26,20 @@ This directory is the default artifact bundle root for the repository workflow.
2426

2527
## Artifact Roles
2628

29+
### Final product artifacts
30+
31+
- `skills/index.md` and `skills/*.md`: grounded AI-consumable Skill documents
32+
33+
### Intermediate artifacts
34+
2735
- `project-summary.md`: human-readable project overview
2836
- `skill-blueprint.json`: structural analysis output from Phase 1
2937
- `skill-plan.json`: LLM-planned Skill inventory
30-
- `skills/index.md` and `skills/*.md`: grounded AI-consumable Skill documents
3138
- `report.json`: execution metrics, cost estimates, and impact summaries
39+
- `references/*.md`: supporting architectural and workflow references
3240
- `state/analysis-state.json`: incremental execution cache
3341

34-
In product terms, `.code2skill/` is the workspace-local artifact bundle, while `adapt` writes the final target-facing instruction files into the repository locations where each AI tool expects them.
42+
In product terms, `.code2skill/` is the workspace-local artifact bundle. The final repository-local product is the generated Skill set, while `adapt` publishes that Skill layer into the repository locations where each AI tool expects to read it.
3543

3644
## Adapted Outputs
3745

docs/python-api.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ The pipeline functions return `ScanExecution`, which includes:
7676
- `report_path`
7777
- `report`
7878

79+
The embedded `ExecutionReport` also distinguishes between:
80+
81+
- `final_product_files`: the generated Skill artifacts inside the bundle
82+
- `intermediate_artifact_files`: blueprint, plan, references, report, and state-side artifacts that support the workflow
83+
7984
The lower-level config and report dataclasses are also exported from the package root. The package root also exports the new artifact and summary contracts used by the workflow-oriented surface:
8085

8186
```python

0 commit comments

Comments
 (0)