happypeter / haoduoshipin

好多视频

Home Page:http://haoduoshipin.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

如何把文档转换成容易懂的内容?

happypeter opened this issue · comments

  • 术语处理
    • 文档里面直接提到七个术语,可能有四个是可以用白话绕过去不说的
    • 绕不过去的几个术语,直接给出,然后跟上白话解释
  • 故事性处理
    • 文档一般比较平铺
    • 教程应该更加像个故事(解释工作流程)
  • 文章要有自己的生命活力
    • 要有明确的中心和主线
    • 内容分三部分,每部分都要在主线上层层递进,扣住中心
    • 每部分的第一句都是这部分的简介,最后一段都是这部分的总结
    • 每一个自然段都要有清晰的中心,不能跑题
  • 每句话都要是白话,都要明确表达观点
  • 不允许有夹生饭,郭德纲说每个字都要送到别人耳朵里面,教程要保证每句话都能直接送到大家的脑子里面
  • 最终大家会把所有的话拼成拼图
  • 没有孤立偏离中心的话

放到 shimo 了。