| File | Kind | Size |
|---|---|---|
| README.md | markdown | 2.3 KB |
| SKILL.md | skill md | 33.9 KB |
| examples/README.md | markdown | 555 B |
| examples/example_planning.md | markdown | 3.2 KB |
| examples/example_user_manual.md | markdown | 3.3 KB |
| templates/code_material.md | markdown | 800 B |
| templates/main_doc.md | markdown | 2.4 KB |
| templates/planning_doc_template.md | markdown | 3.2 KB |
| templates/user_manual.md | markdown | 14.3 KB |
templates/main_doc.md
View on GitHub<!--
⚠️ AI 生成警告 ⚠️
生成时必须将所有 {占位符} 替换为从项目代码中分析得到的实际内容。
禁止在最终文档中保留任何 {xxx} 格式的占位符!
-->
# 软著主文档模板
## 开发的硬件环境
CPU: {开发环境CPU}
内存: {开发环境内存}
系统盘: {开发环境系统盘}
带宽: {开发环境带宽}
## 运行的硬件环境
CPU: {运行环境CPU}
内存: {运行环境内存}
系统盘: {运行环境系统盘}
带宽: {运行环境带宽}
## 开发该软件的操作系统
{操作系统信息}
## 软件开发环境 / 开发工具
开发环境:{开发环境描述}
开发工具:{开发工具列表}
## 该软件的运行平台 / 操作系统
运行平台:{运行平台描述}
操作系统:{操作系统版本}
## 软件运行支撑环境 / 支持软件
服务器:{服务器软件}
语言版本:{编程语言版本}
数据库:{数据库软件}
浏览器:{支持的浏览器}
## 源程序量
{代码行数}
## 开发目的
{开发目的描述,说明项目背景、市场需求、应用价值等。建议 3-5 句话,包含:
1. 行业背景和痛点
2. 本软件的解决方案
3. 预期实现的核心价值}
## 面向领域 / 行业
{面向的行业领域}
## 软件的主要功能
### 用户端功能
**{用户端模块1名称}**:
- {功能点1}
- {功能点2}
- {功能点3}
**{用户端模块2名称}**:
- {功能点1}
- {功能点2}
- {功能点3}
<!-- 根据规划书中的用户端功能清单逐个展开 -->
### 管理端功能
**{管理端模块1名称}**:
- {功能点1}
- {功能点2}
- {功能点3}
**{管理端模块2名称}**:
- {功能点1}
- {功能点2}
- {功能点3}
<!-- 根据规划书中的管理端功能清单逐个展开 -->
## 软件的技术特点
### 架构设计
{描述系统整体架构,如前后端分离、微服务、分布式、MVC 等}
### 性能优化
{描述性能优化措施,如缓存机制、数据库优化、CDN 加速、异步处理等}
### 安全性保障
{描述安全措施,如数据加密、身份认证、权限控制、SQL 注入防护、XSS 防护等}
### 用户体验
{描述用户体验优化,如响应式设计、实时更新、流畅的交互动画等}
### 数据处理
{描述数据处理能力,如数据分析、数据可视化、批量导入导出等}
## 软件代码文档
{代码材料将单独生成}
## 文档鉴别材料
{使用说明书将单独生成}
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |