project-interview-skill 1.1.0 → 1.3.0

package/README.md

@@ -3,7 +3,7 @@
   <p><a href="https://github.com/Jaxon1216/interview-analyzer-skill/blob/main/README_EN.md">English</a></p>
   <p><em>把你的项目经历，变成可复述、可追问、可上场的面试战斗手册。</em></p>
   <p>
-    <a href="SKILL.md"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
+    <a href="LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
     <img alt="Type: Agent Skill" src="https://img.shields.io/badge/Type-Agent%20Skill-7c3aed">
     <img alt="Trae Compatible" src="https://img.shields.io/badge/Trae-Compatible-111827">
     <img alt="Cursor Compatible" src="https://img.shields.io/badge/Cursor-Compatible-00B8D9">
@@ -13,25 +13,50 @@
   </p>
 </div>
 
-把真实项目快速整理成两份可直接用于面试准备的文档（输出到目标项目根目录）：
+把真实项目变成能讲、能追问、能复习的面试材料，输出到目标项目的 `interview-prep/{简称}/` 目录。
 
-- `导学-{简称}.md`：重点亮点、代码阅读路径、学习顺序与必备知识点
-- `面经-{简称}.md`：简历可用摘要 + 面试题口播（第一人称 STAR）
+## 核心能力
 
-## 效果演示
+- 核心链路探索：追踪入口、关键机制、失败边界与源码证据，再提炼技术支柱
+- 简历 bullet：把代码事实整理成可复用的简历表达
+- STAR 口播：围绕每条 bullet 生成主问、追问和第一人称回答
+- 表达护栏：约束内部名词和实现细节，转换成外部面试官听得懂的说法
+- 学习路径：按优先级安排必备知识、源码阅读和验证任务
+- 前后端样例：内置参考模板，帮助校准表达深度和面试口径
 
-下面这张合并图展示了触发输入与面经输出示例：
-
-![Demo](https://raw.githubusercontent.com/Jaxon1216/interview-analyzer-skill/main/demo.jpg)
-
-## 安装方式
-
-推荐使用 `npx`，不需要 clone 仓库：
+## 快速开始
 
 ```bash
 npx project-interview-skill install
 ```
 
+安装完成后，在目标项目根目录开启新对话，直接输入：
+
+```text
+/project-interview-skill 简称：电商；项目描述：......；技术栈：Vue3、Pinia、Vite；求职方向：前端
+```
+
+## 生成结果
+
+从一次自然语言输入开始，Skill 会把项目拆成三条可执行的准备路径：
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Jaxon1216/interview-analyzer-skill/main/docs/images/bullet-output.png" alt="简历 bullet 与提示词侧栏" width="100%">
+</p>
+
+<table>
+  <tr>
+    <td width="50%" align="center"><strong>面经：按简历支柱展开</strong></td>
+    <td width="50%" align="center"><strong>导学：安排学习顺序</strong></td>
+  </tr>
+  <tr>
+    <td><img src="https://raw.githubusercontent.com/Jaxon1216/interview-analyzer-skill/main/docs/images/interview-questions.png" alt="面试问题与口播答案" width="100%"></td>
+    <td><img src="https://raw.githubusercontent.com/Jaxon1216/interview-analyzer-skill/main/docs/images/learning-path.png" alt="学习顺序与推荐阅读" width="100%"></td>
+  </tr>
+</table>
+
+## 安装方式
+
 默认安装到用户级通用 Agent 目录：
 
 ```text
@@ -86,18 +111,14 @@ npx project-interview-skill install --project --trae
 
 ## 使用方式
 
-在被分析项目的工作区开启新对话，例如：
-
-```text
-/project-interview-skill 简称：电商；项目描述：......（背景/职责/难点/结果）；技术栈：Vue3、Pinia、Vite；求职方向：前端
-```
-
-随后在该业务项目根目录生成：
+随后在该业务项目根目录的 `interview-prep/{简称}/` 下生成：
 
 | 文件 | 用途 |
 |------|------|
-| `导学-{简称}.md` | 前置知识、必备知识点、推荐阅读（含仓库相对路径）、原理与设计决策；文末可含「量化与验证（含待测）」 |
-| `面经-{简称}.md` | 1～2 句简历摘要、项目 bullets、15～25 道面试题（主问/追问口播） |
+| `导学.md` | 前置知识、源码阅读路线、核心链路与证据、原理和设计决策；文末可含「量化与验证（含待测）」 |
+| `面经.md` | 1～2 句简历摘要、以 `- **支柱名：**` 开头的 bullet、按简历支柱展开的面试题（主问/追问口播） |
+
+复杂知识点可在 `导学/01-主题.md` 等子文件中展开，由 `导学.md` 链接；默认只生成两份主文件。
 
 也可以不写 slash 命令，直接描述“请基于这个项目生成导学和面经”。
 
@@ -114,54 +135,48 @@ cd interview-analyzer-skill
 
 npm 包不会打包 `install.sh`；对普通用户优先推荐 `npx project-interview-skill ...`。
 
+## 可直接复制的 Skill Bundle
+
+仓库外层是 npm CLI 和开发工程；真正可独立迁移的 Skill 位于：
+
+```text
+skill/project-interview-skill/
+├── SKILL.md
+├── references/
+└── scripts/
+```
+
+复制这个目录即可迁移 Skill，不需要复制 `bin/`、`tests/` 或 `package.json`。npm CLI 安装时也只从这个目录生成目标 Skill。
+
 ## 仓库结构
 
 ```text
 interview-analyzer-skill/
+|-- skill/
+|   `-- project-interview-skill/
+|       |-- SKILL.md
+|       |-- references/
+|       |   |-- rules/
+|       |   |-- templates/
+|       |   |-- examples/
+|       |   `-- excellent-resumes/
+|       `-- scripts/
 |-- bin/
 |   `-- project-interview-skill.js
-|-- SKILL.md
 |-- install.sh
 |-- package.json
+|-- .npmrc
 |-- README.md
 |-- README_EN.md
-|-- demo.jpg
+|-- docs/
+|   |-- images/
+|   `-- promo.md
 |-- LICENSE
-|-- references/
-|   |-- interview-rubric.md
-|   |-- star-framework.md
-|   |-- output-templates.md
-|   |-- oral-and-resume-patterns.md
-|   `-- oral-style-samples.md
-|-- scripts/
-|   |-- check_inputs.py
-|   `-- build_prompt.py
 `-- tests/
 ```
 
-## 维护与发布
-
-本项目作为 npm CLI 包发布，不需要编译。npm 包会按 `package.json` 的 `files` 白名单打包：
-
-```bash
-npm pack --dry-run
-npm publish --access public
-```
-
-本地验证：
-
-```bash
-npm test
-npm run pack:check
-node bin/project-interview-skill.js install --trae --dry-run
-```
-
 ## 常见问题
 
-### `.npmrc` 是必要的吗？
-
-不是 npm 包必须文件。它只用于本仓库开发时指定 registry。真正发布到公网 npm 的关键配置是 `package.json` 里的 `publishConfig.registry`。
-
 ### 为什么默认安装到 `.agents/skills`？
 
 这是最稳的用户级默认值，不依赖猜测用户正在使用哪个产品。如果你明确使用 Trae、Cursor、VS Code 或 Claude Code，使用对应参数即可。

package/README_EN.md

@@ -0,0 +1,203 @@
+<div align="center">
+  <h1>project-interview-skill</h1>
+  <p><a href="https://github.com/Jaxon1216/interview-analyzer-skill/blob/main/README.md">简体中文</a></p>
+  <p><em>Turn your project experience into interview-ready docs you can actually explain and defend.</em></p>
+  <p>
+    <a href="LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
+    <img alt="Type: Agent Skill" src="https://img.shields.io/badge/Type-Agent%20Skill-7c3aed">
+    <img alt="Trae Compatible" src="https://img.shields.io/badge/Trae-Compatible-111827">
+    <img alt="Cursor Compatible" src="https://img.shields.io/badge/Cursor-Compatible-00B8D9">
+    <img alt="VS Code Compatible" src="https://img.shields.io/badge/VS%20Code-Compatible-007ACC?logo=visual-studio-code&logoColor=white">
+    <img alt="Claude Code Compatible" src="https://img.shields.io/badge/Claude%20Code-Compatible-7c3aed">
+    <img alt="Codex Compatible" src="https://img.shields.io/badge/Codex-Compatible-0A66C2">
+  </p>
+</div>
+
+Turn a real codebase into interview material you can explain, defend, and study, written under `interview-prep/{short-name}/` in the target project.
+
+## Core Capabilities
+
+- Core-flow investigation: trace entry points, mechanisms, failure boundaries, and source evidence into technical pillars
+- Resume bullets: turn code facts into reusable resume language
+- STAR speaking answers: generate primary questions, follow-ups, and first-person responses
+- Explanation guardrails: translate internal implementation terms into interviewer-friendly language
+- Study path: prioritize concepts, source reading, and verification tasks
+- Frontend and backend examples: provide reference templates for depth and phrasing
+
+## Quick Start
+
+```bash
+npx project-interview-skill install
+```
+
+After installation, open the target project root in a new chat and enter:
+
+```text
+/project-interview-skill Short name: ecommerce; project description: ...; stack: Vue3, Pinia, Vite; target role: frontend
+```
+
+## Generated Output
+
+Starting from one natural-language request, the Skill turns a codebase into three practical preparation views:
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Jaxon1216/interview-analyzer-skill/main/docs/images/bullet-output.png" alt="Resume bullets and prompt sidebar" width="100%">
+</p>
+
+<table>
+  <tr>
+    <td width="50%" align="center"><strong>Interview guide: resume-driven questions</strong></td>
+    <td width="50%" align="center"><strong>Study guide: an ordered learning path</strong></td>
+  </tr>
+  <tr>
+    <td><img src="https://raw.githubusercontent.com/Jaxon1216/interview-analyzer-skill/main/docs/images/interview-questions.png" alt="Interview questions and spoken answers" width="100%"></td>
+    <td><img src="https://raw.githubusercontent.com/Jaxon1216/interview-analyzer-skill/main/docs/images/learning-path.png" alt="Learning order and recommended reading" width="100%"></td>
+  </tr>
+</table>
+
+## Install
+
+The default target is the user-level generic Agent directory:
+
+```text
+~/.agents/skills/project-interview-skill/
+```
+
+If you know which editor or Agent you use, specify it explicitly:
+
+| Target | User-level command | Install location |
+|--------|--------------------|------------------|
+| Generic Agent / Codex | `npx project-interview-skill install --agents` | `~/.agents/skills/project-interview-skill/` |
+| Trae | `npx project-interview-skill install --trae` | `~/.trae/skills/project-interview-skill/` |
+| Cursor | `npx project-interview-skill install --cursor` | `~/.cursor/rules/project-interview-skill/` |
+| VS Code | `npx project-interview-skill install --vscode` | `~/.copilot/instructions/project-interview-skill.instructions.md` |
+| Claude Code | `npx project-interview-skill install --claude-code` | `~/.claude/skills/project-interview-skill/` |
+| Codex | `npx project-interview-skill install --codex` | `~/.agents/skills/project-interview-skill/` |
+
+Install every supported target:
+
+```bash
+npx project-interview-skill install --all
+```
+
+Preview paths without writing files:
+
+```bash
+npx project-interview-skill install --trae --dry-run
+npx project-interview-skill doctor
+```
+
+## Project-Level Install
+
+To install the skill only for one application repository, run the command from that repository root:
+
+```bash
+cd /path/to/your-project
+npx project-interview-skill install --project --trae
+```
+
+Supported project-level targets:
+
+| Target | Project-level command | Install location |
+|--------|-----------------------|------------------|
+| Generic Agent / Codex | `npx project-interview-skill install --project --agents` | `.agents/skills/project-interview-skill/` |
+| Trae | `npx project-interview-skill install --project --trae` | `.trae/rules/project-interview-skill/` |
+| Cursor | `npx project-interview-skill install --project --cursor` | `.cursor/rules/project-interview-skill/` |
+| VS Code | `npx project-interview-skill install --project --vscode` | `.github/instructions/project-interview-skill.instructions.md` |
+| Claude Code | `npx project-interview-skill install --project --claude-code` | `.claude/skills/project-interview-skill/` |
+| Codex | `npx project-interview-skill install --project --codex` | `.agents/skills/project-interview-skill/` |
+
+Restart the target IDE or Agent after installation.
+
+## Usage
+
+The skill creates these files under the target project root:
+
+| File | Purpose |
+|------|---------|
+| `interview-prep/{short-name}/导学.md` | Prerequisites, repo-relative reading guide, traced system flows and evidence, design decisions, and optional measurement notes |
+| `interview-prep/{short-name}/面经.md` | 1-2 sentence resume summary, titled architecture bullets, and interview Q&A mapped to those bullets |
+
+Complex topics can be expanded in `interview-prep/{short-name}/导学/01-topic.md` and linked from the main study guide. The default output remains two files.
+
+You can also invoke it naturally by asking for project interview preparation docs.
+
+## Source Checkout Compatibility
+
+`install.sh` is kept for users who clone the repository. It is only a wrapper around the Node CLI:
+
+```bash
+git clone https://github.com/Jaxon1216/interview-analyzer-skill.git
+cd interview-analyzer-skill
+./install.sh --trae
+./install.sh --project --cursor
+```
+
+The npm package does not include `install.sh`; regular users should prefer `npx project-interview-skill ...`.
+
+## Standalone Skill Bundle
+
+The repository root contains the npm CLI and development files. The independently portable Skill bundle is:
+
+```text
+skill/project-interview-skill/
+├── SKILL.md
+├── references/
+└── scripts/
+```
+
+Copy this directory to migrate the Skill; `bin/`, `tests/`, and `package.json` are not required. The npm CLI also builds installed targets from this directory only.
+
+## Repository Structure
+
+```text
+interview-analyzer-skill/
+|-- skill/
+|   `-- project-interview-skill/
+|       |-- SKILL.md
+|       |-- references/
+|       |   |-- rules/
+|       |   |-- templates/
+|       |   |-- examples/
+|       |   `-- excellent-resumes/
+|       `-- scripts/
+|-- bin/
+|   `-- project-interview-skill.js
+|-- install.sh
+|-- package.json
+|-- .npmrc
+|-- README.md
+|-- README_EN.md
+|-- docs/
+|   |-- images/
+|   `-- promo.md
+|-- LICENSE
+`-- tests/
+```
+
+## FAQ
+
+### Why does the default install target `.agents/skills`?
+
+It is the least surprising user-level default and avoids guessing which product the user wants. Use an explicit flag for Trae, Cursor, VS Code, Claude Code, or Codex.
+
+### Does `install` auto-detect products?
+
+No. The behavior is intentionally narrow: the default installs only to `.agents/skills`, product-specific installs require `--trae`, `--cursor`, `--vscode`, `--claude-code`, or `--codex`. `doctor` only prints paths.
+
+### Do updates apply automatically?
+
+No. Installed skill folders are copied artifacts. Re-run the install command:
+
+```bash
+npx project-interview-skill install --trae
+```
+
+## Support
+
+- **Contact** (feedback, commercial use, derivatives): **jiangxu05@outlook.com**
+- **Star**, **Fork**, **Issues / PRs** are welcome.
+
+## License
+
+Licensed under the **[MIT License](LICENSE)**. The file includes the English legal text plus an unofficial Chinese translation for convenience; if they disagree, the English section controls.

package/bin/project-interview-skill.js

@@ -8,6 +8,7 @@ const path = require('path');
 const PACKAGE_NAME = 'project-interview-skill';
 const SKILL_DIR_NAME = 'project-interview-skill';
 const SUPPORTED_PRODUCTS = ['agents', 'trae', 'cursor', 'vscode', 'claude-code', 'codex'];
+const SKILL_BUNDLE_PATH = path.join('skill', 'project-interview-skill');
 const COLORS = {
   reset: '\x1b[0m',
   bold: '\x1b[1m',
@@ -20,8 +21,6 @@ const BUNDLE_ENTRIES = [
   'SKILL.md',
   'references',
   'scripts',
-  'README.md',
-  'LICENSE',
 ];
 
 function main() {
@@ -146,6 +145,7 @@ function doctor(options) {
   const home = os.homedir();
 
   info(`Package root: ${packageRoot()}`);
+  info(`Skill bundle: ${skillBundleRoot()}`);
   info(`Current project: ${cwd}`);
   info(`Home: ${home}`);
   console.log('');
@@ -240,9 +240,9 @@ function installProduct(product, target, options) {
 }
 
 function validatePackage() {
-  const skillPath = path.join(packageRoot(), 'SKILL.md');
+  const skillPath = path.join(skillBundleRoot(), 'SKILL.md');
   if (!fs.existsSync(skillPath)) {
-    throw new Error(`Missing SKILL.md at ${skillPath}`);
+    throw new Error(`Missing Skill bundle entry: ${skillPath}`);
   }
 
   const firstLine = fs.readFileSync(skillPath, 'utf8').split(/\r?\n/, 1)[0];
@@ -255,7 +255,7 @@ function copyBundle(destination) {
   fs.mkdirSync(destination, { recursive: true });
 
   for (const entry of BUNDLE_ENTRIES) {
-    const source = path.join(packageRoot(), entry);
+    const source = path.join(skillBundleRoot(), entry);
     if (!fs.existsSync(source)) {
       continue;
     }
@@ -322,7 +322,7 @@ function writeFile(filePath, content) {
 }
 
 function skillBody() {
-  const content = fs.readFileSync(path.join(packageRoot(), 'SKILL.md'), 'utf8');
+  const content = fs.readFileSync(path.join(skillBundleRoot(), 'SKILL.md'), 'utf8');
   const lines = content.split(/\r?\n/);
   let delimiterCount = 0;
   const body = [];
@@ -341,7 +341,7 @@ function skillBody() {
 }
 
 function extractDescription() {
-  const content = fs.readFileSync(path.join(packageRoot(), 'SKILL.md'), 'utf8');
+  const content = fs.readFileSync(path.join(skillBundleRoot(), 'SKILL.md'), 'utf8');
   const lines = content.split(/\r?\n/);
   let inFrontmatter = false;
   let inDescriptionBlock = false;
@@ -383,6 +383,10 @@ function packageRoot() {
   return path.resolve(__dirname, '..');
 }
 
+function skillBundleRoot() {
+  return path.join(packageRoot(), SKILL_BUNDLE_PATH);
+}
+
 function printHelp() {
   console.log(`${bold(PACKAGE_NAME)}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "project-interview-skill",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Install a project interview preparation skill for AI coding agents.",
   "license": "MIT",
   "author": "EastonJiang <jiangxu05@outlook.com>",
@@ -14,10 +14,11 @@
   },
   "files": [
     "bin/",
-    "SKILL.md",
-    "references/",
-    "scripts/",
+    "skill/project-interview-skill/SKILL.md",
+    "skill/project-interview-skill/references/",
+    "skill/project-interview-skill/scripts/*.py",
     "README.md",
+    "README_EN.md",
     "LICENSE"
   ],
   "scripts": {