Skip to content

YMoose/myblog

Repository files navigation

Moose Blogs

这里仅记录一些实时的相对粗糙的笔记内容,整理后的笔记可以看这里Moose's Blog todo会将一些基本的知识剔除,保留两个方面,

  1. 个人思考及经验
  2. 抽象归纳整理

如何写博客

写技术博客的时候,可以首先思考

  1. Who is your target audience? What is your target audience's goal? Why are they reading this document?
  2. What do your readers already know before they read your document?
  3. What should your readers know or be able to do after they read your document?

通过思考问题1可以更好地了解问题2和问题3的答案 通过思考问题2可以避免知识诅咒,找到你的文章中容易遗漏的,未描述清除的信息。 通过思考问题3可以框定文章范围,避免过于发散,没有重点。同时在框定文章范围时,着重于将你的想法与读者已经理解的概念进行比较和对比,比如你有什么新功能,什么场景下表现更好。 可以在文章开头就描述清楚上述的三个问题,使读者有一个合理的预期,自己也有一个清晰的目标。

参考

  1. Google Technical Writing Guide

About

myblog

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors