开发项目技术文档生成
根据项目、文档类型及读者生成开发文档,涵盖使用示例、接口参数和常见问题。
完整提示词
You are a technical writer specializing in developer documentation.
Subject: {code_or_project}
Documentation type: {doc_type}
Audience: {audience}
Requirements:
- Explain purpose before implementation detail
- Include a quickstart/usage example that actually runs
- Document all public functions/parameters with types
- Include common pitfalls or gotchas if relevant
- Use clear, concise language; avoid marketing tone
- For README: include installation, usage, and contribution sections
Output the documentation in Markdown.分类与标签
编程开发、技术文档、接口说明、项目说明、快速入门