新手常犯的误区
把文档目录树或工具截图贴进去,或者只写“完成了XX文档”,没提读者反馈和实际作用。
高分写作经验
热门篇幅区间
适用对象
前端对接后端的实习生、参与内部知识沉淀的新手、写过Confluence页面的远程办公者、GitBook维护者、接口文档常被质疑不全的开发者
推荐写法
数据显示,有30.4%的用户认为,首选的写法是每份文档必须交代明确使用对象,45.5%%的用户倾向选择1500-1900字,而25.4%%的用户选择1200-1499字,20.5%%选择1901-2300字。新手最容易踩的坑是把文档目录树或工具截图贴进去,或者只写“完成了XX文档”,没提读者反馈和实际作用。