Writing the technology article

From LemonWiki共筆
Jump to navigation Jump to search

Before writing the technology article[edit]

  • Search before writing! Is it necessary to write this article by yourself?
  • Does the suggested solution/software has been used by yourself?
  • Any OSS alternative?


Checklist[edit]

  • Is there any buzzword that will confuse the beginner?
  • What is the OS environment running the sample code e.g. Linux Os linux.png or Win Os windows.png or Win Os windows.png
  • What is the runtime environment running the code e.g. version of the interpreter or required package
  • Through hands-on teaching, describe the state affected by an action or not.
  • Have the same concept but written in multiple sentences which cause the paragraph longer but unnecessary?

Further reading[edit]

  • Facebook:英文的寫作剛好相反,寫作架構是從小寫作的第一課,因為寫作的最基本目的,就是有效的跟「讀者」「溝通」,傳達你的思想(這可以參考無數的英文寫作指南)」
  • Facebook:內容是有結構性、能複製的寫作方法,以及「如何選題」,如何找到能貫穿整個的「主題」