Writing the technology article: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
== Checklist == | == Checklist == | ||
* Is there any buzzword that will confuse the beginner? | * Is there any buzzword that will confuse the beginner? | ||
* {{Acronym | acronym=OS | def=operating system }} environment running the sample code e.g. {{Linux}} or {{Win}} or {{Win}} | * What is the {{Acronym | acronym=OS | def=operating system }} environment running the sample code e.g. {{Linux}} or {{Win}} or {{Win}} | ||
* | * 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. | * 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? | * Have the same concept but written in multiple sentences which cause the paragraph longer but unnecessary? | ||
other | |||
* Time-related terms: Is it acceptable to include time-related terms, such as "today," in your writing? If not, simply remove any time-related terms. | |||
== Further reading == | |||
* [https://www.facebook.com/howard.shiu/posts/10158876104917911 Facebook]:英文的寫作剛好相反,寫作架構是從小寫作的第一課,因為寫作的最基本目的,就是有效的跟「讀者」「溝通」,傳達你的思想(這可以參考無數的英文寫作指南)」 | |||
* [https://www.facebook.com/YSL31/posts/3649325855177943 Facebook]:內容是有結構性、能複製的寫作方法,以及「如何選題」,如何找到能貫穿整個的「主題」 | |||
[[Category:PKM]] [[Category:Writing]] | [[Category:PKM]] [[Category:Writing]] | ||
Latest revision as of 10:15, 7 March 2023
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 or Win or Win
- 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?
other
- Time-related terms: Is it acceptable to include time-related terms, such as "today," in your writing? If not, simply remove any time-related terms.