Readme 代码审查

文档社区

作者仓库星标 0
作者仓库 skills-registry

解读按原文结构重写，命令、链接、术语均保留；右侧可核对作者原始 SKILL.md

原文结构

Key Features：Scans .github/copilot/ directory files for project metadata Reviews copilot-instructions.md for development guidelines Extracts technology stack information
Generated Sections：Project Name and Description Technology Stack with versions Project Architecture overview

适用与边界

When to Use：Creating initial README for a project Updating README to reflect architectural changes Standardizing documentation structure across projects
当前原文没有单列不适用场景或限制。

原文中的明确线索

要点：「Generate a comprehensive README.md for your repository by analyzing existing documentation and codebase structure.」
文件与命令：.github/copilot/、copilot-instructions.md、README.md、.github/copilot、AICyberGuardian/storycraftr-next、github.com/AICyberGuardian/storycraftr-next

流狐整理：以上内容来自当前 SKILL.md 的章节与原词；未补写作者没有声明的工具、兼容性或能力。

流狐档案作者与许可取自来源；运行、权限和网络为流狐检测或估算

流狐分类: 文档
作者声明 Agent: 未找到明确声明；不据此推断已兼容或已测试
静态检查: 88 / 100 · 启发式扫描，不代表运行安全
作者 / 版本 / 许可: @tomevault-io · 未声明 license
流狐 Token 估算: 低消耗
流狐接入估算: 即装即用
是否需要外部 API Key: 未发现要求
检测到的系统要求: 未声明
底层运行要求: 未声明
检测到的文件与系统行为: 只读
允许写入 / 修改
检测到的网络行为: 仅限本地
安装命令数: 无（仅作为资料）

档案由构建时根据 SKILL.md 与安装命令自动衍生，可能与作者实际意图存在差异。

需要注意： 未限定 allowed-tools，默认拥有全部工具权限。

输出预览 readme-blueprint-generator.preview

作者没有在当前 SKILL.md 中定义固定输出样例。

SKILL.md SKILL.md

# README Blueprint Generator

Generate a comprehensive README.md for your repository by analyzing existing documentation and codebase structure.

## Key Features

- Scans `.github/copilot/` directory files for project metadata
- Reviews `copilot-instructions.md` for development guidelines
- Extracts technology stack information
- Documents project architecture
- Includes getting started guides
- Lists folder structure and project organization
- Summarizes development workflow and coding standards
- Documents testing approaches
- Creates contribution guidelines

## When to Use

- Creating initial README for a project
- Updating README to reflect architectural changes
- Standardizing documentation structure across projects
- Adding comprehensive onboarding information
- Generating developer-focused documentation

## Generated Sections

- Project Name and Description
- Technology Stack with versions
- Project Architecture overview
- Getting Started and Installation
- Project Structure explanation
- Key Features and Functionality
- Development Workflow
- Coding Standards and Conventions
- Testing Approaches
- Contributing Guidelines
- Links to Additional Documentation

---
> Source: [AICyberGuardian/storycraftr-next](https://github.com/AICyberGuardian/storycraftr-next) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-23 -->

证据边界与执行链路

作者原文负责流程事实；流狐只索引当前章节、要点、文件与命令。

章节    -> Key Features → When to Use → Generated Sections
要点    -> Generate a comprehensive README.md for your repository by analyzing existing documentation and codebase structure.
文件/命令 -> .github/copilot/ · copilot-instructions.md · README.md · .github/copilot · AICyberGuardian/storycraftr-next · github.com/AICyberGuardian/storycraftr-next
内容 SHA-256 -> fa4356415a47

原文结构

适用与边界

原文中的明确线索

README Blueprint Generator

Key Features

When to Use

Generated Sections

讨论