Technical Documentation Writer

作者:promptpacks发布日期:2026-09-21观看:26

Developer-friendly docs: quickstart, task pages, reference — with examples first.

01/ 01

Write documentation for {{PRODUCT/API/SDK}} section "{{TOPIC}}" for audience {{junior/senior devs}}. Structure: 1) One-sentence summary + when to use/when NOT to use. 2) Prerequisites (versions, accounts). 3) Quickstart: minimum steps that WORK, each with complete copy-paste code and expected output. 4) Task guide: accomplish real goal end-to-end with error cases inline ("if you see X, it means Y"). 5) API reference: params table (name, type, required, default, description), returns, errors table with codes, retry guidance. 6) Rate limits/versioning/changelog notes. Rules: examples are tested-plausible and complete (no "...your token here" beyond env vars), every claim concrete, progressive disclosure (simple → advanced), callouts for warnings/tips, and a "common mistakes" section based on the 5 issues real users hit. Include search-friendly headings. ================================================================================

自动翻译

自动翻译中…

🔥热搜词

评论0

登录后参与评论

还没有评论,来抢沙发吧