自述文件蓝图生成器

文档 社区

技能解读

当前原文的自动摘译,尚未人工审校。

主要特点

扫描.github/copilot/目录文件以获取项目元数据评论copilot-instructions.md以获取开发指南提取技术堆栈信息记录项目架构包括入门指南

何时使用

为项目创建初始自述文件 更新自述文件以反映架构变化 跨项目标准化文档结构 添加全面的入门信息 生成以开发人员为中心的文档

生成的部分

项目名称和描述 技术堆栈及其版本 项目架构概述 入门和安装 项目结构说明

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@tomevault-io · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

作者说明文件(原文) 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 -->

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。