SoftCopyright - Intelligent Software Copyright Application Material Generation Tool

Overview

1. Read user input, if it's keywords, first search for relevant content
2. Analyze project source code structure and content
3. Generate a detailed software manual (about 2000-3000 words)
4. Generate compliant source code documents (60 pages, 50 lines per page)
5. Export to PDF format for software copyright application use

Supported Trigger Commands

• "Help me generate software copyright application materials" - Process the current directory project
• "Generate software manual" - Only generate the software manual
• "Generate source code document" - Only generate the source code document
• Any keywords - First search for relevant content, then ask whether to generate software copyright materials

Workflow

Step 1: Understand User Intent

// 检查用户输入类型
if (用户输入包含 "软著" || "著作权") {
  生成类型 = "全部材料"
} else if (用户输入包含 "软件说明书") {
  生成类型 = "说明书"
} else if (用户输入包含 "源代码" || "源码") {
  生成类型 = "源代码文档"
} else if (用户输入是关键词) {
  先搜索相关内容
  询问用户是否生成软著材料
}

Step 2: Project Path Confirmation

// 默认使用当前目录
let projectPath = process.cwd()

// 询问用户确认路径
await confirmProjectPath(projectPath)

Step 3: Generate Software Copyright Materials Using CLI

# 方式1: 使用关键词触发index.js（交互式）
cd ~/.claude/skills/softcopyright
node scripts/index.js 软著

# 方式2: 使用cli.js直接生成（推荐）
node scripts/cli.js generate --project <项目路径>

# 方式3: 使用快捷命令（最佳体验）
~/.claude/skills/softcopyright/softcopyright-generate --project . --auto-pdf

# 方式4: 技能系统自动调用
用户输入"帮我生成软著" → 自动执行: softcopyright-generate --project . --auto-pdf

• Automatically scan project source code
• Identify source code file types
• Analyze project structure and technology stack
• Generate HTML-formatted software manuals and source code documents
• Ask users whether to automatically open in the browser and print as PDF

Step 4: Generation Options

1. Generate all materials (software manual + source code document)
2. Only generate software manual
3. Only generate source code document
4. Only view project statistics

Step 5: Output Location

<项目目录>/softcopyright-output/

• 软件说明书_<项目名>_<时间戳>.html

• 源代码文档_<项目名>_<时间戳>.html

Step 6: Export to PDF

# 添加--auto-pdf选项
node scripts/cli.js generate --project <项目路径> --auto-pdf

• Automatically open HTML in the browser
• Automatically pop up the print dialog after 3 seconds
• Select "Save as PDF" to complete

1. Open the generated HTML file in the browser
2. Press Cmd+P (macOS) or Ctrl+P (Windows/Linux)
3. In print settings:
   • Expand "More settings"
   • Check "Headers and footers"
   • Select "Save as PDF"
4. Save the PDF file

Tool Script Usage Instructions

scanner.js - Source Code Scanning Tool

node ~/.claude/skills/softcopyright/scripts/scanner.js <项目路径>

doc-generator.js - Software Manual Generator

node ~/.claude/skills/softcopyright/scripts/doc-generator.js \
  --type manual \
  --input <项目分析JSON> \
  --template <模板文件> \
  --output <输出PDF路径>

source-exporter.js - Source Code Document Generator

node ~/.claude/skills/softcopyright/scripts/source-exporter.js \
  --input <源码目录> \
  --output <输出PDF路径> \
  --pages 60 \
  --lines-per-page 50

Usage Examples

Example 1: Complete Software Copyright Material Generation

1. Confirm project path: Current directory
2. Run source code scanning tool
3. Analyze project structure and technology stack
4. Generate software manual
5. Generate source code document
6. Export PDF files
7. Show generation results to user

Example 2: Generate After Keyword Search

1. Search for information related to "React e-commerce system"
2. Display search results
3. Ask: "Do you need to generate software copyright application materials for the React e-commerce system?"
4. Execute the complete generation process after user confirmation

Example 3: Only Generate Software Manual

1. Scan project source code
2. Analyze project functions
3. Generate software manual
4. Export PDF file

Output File Specifications

Software Manual PDF

• File name:

  软件说明书_项目名称_YYYYMMDD.pdf

• Word count requirement: 2000-3000 words
• Contains all required chapters
• Professional typesetting and formatting

Source Code Document PDF

• File name:

  源代码文档_项目名称_YYYYMMDD.pdf

• Page count requirement: 60 pages (or process all code)
• Lines per page: No less than 50 lines
• No comments and no copyright information
• Ensure code continuity

Software Copyright Application Requirements

Source Code Document Requirements

1. Page count requirement: Usually 20-60 pages are required
2. Format requirement: No more than 50 lines of code per page
3. Comment requirement: All comments need to be removed, only pure code remains
4. Headers and footers: Need to include software name and version number
5. Code continuity: Need to ensure code continuity and integrity

Software Manual Requirements

1. Detailed content: About 2000-3000 words
2. Complete structure: Contains all required chapters
3. Highlight key points: Highlight the originality of the software
4. Professional description: Use professional technical descriptions

Technology Stack

• Node.js: Main runtime environment
• PDFKit: PDF document generation
• glob: File pattern matching
• commander: CLI parameter parsing
• chalk: Terminal color output
• inquirer: Interactive command-line interface

Dependency Installation

# 确保使用合适的 Node 版本
nvm use 18

# 安装依赖
cd ~/.claude/skills/softcopyright
npm install

Best Practices

1. Accurate project analysis: Ensure correct identification of project type and technology stack
2. Detailed and professional content: Generate professional technical descriptions and function explanations
3. Standard and compliant formatting: Strictly format according to software copyright application requirements
4. User-friendly interaction: Provide clear progress prompts and confirmation processes
5. Document integrity: Ensure the completeness and accuracy of generated materials

Security Notes

1. Source code security: Do not modify original source code, only read and analyze
2. Privacy protection: Do not upload source code to external services
3. Local processing: All processing is done locally
4. User confirmation: Require user confirmation before important operations

Troubleshooting

Scan Failure

# 检查项目路径
ls -la <项目路径>

# 检查权限
chmod -R 755 <项目路径>

PDF Generation Failure

# 检查依赖安装
cd ~/.claude/skills/softcopyright
npm list

# 重新安装依赖
npm install

Insufficient Memory

1. Exclude unnecessary directories (node_modules, .git, etc.)
2. Process source code files in batches
3. Increase Node.js memory limit

Development and Expansion

scripts/scanner.js

const SUPPORTED_EXTENSIONS = {
  '.rs': {
    'single_line': '//',
    'multi_line': ['/*', '*/'],
    'language': 'rust'
  },
  '.go': {
    'single_line': '//',
    'multi_line': ['/*', '*/'],
    'language': 'go'
  }
}