Writing the technology article: Difference between revisions
Jump to navigation
Jump to search
(Created page with "== Before writing the technology article == * Search before writing! Is it necessary to write this article by yourself? * Does the suggested solution/software has been used b...") |
No edit summary |
||
| Line 7: | Line 7: | ||
== Checklist == | == Checklist == | ||
* Is there any buzzword will | * 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}} | * {{Acronym | acronym=OS | def=operating system }} environment running the sample code e.g. {{Linux}} or {{Win}} or {{Win}} | ||
* Runtime environment running the code e.g. version of interpreter or required package | * Runtime environment running the code e.g. version of the interpreter or required package | ||
* Through hands-on teaching, describe the state affected by 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? | |||
[[Category:PKM]] [[Category:Writing]] | [[Category:PKM]] [[Category:Writing]] | ||
Revision as of 08:59, 22 May 2022
Before writing the technology article
- 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
- Is there any buzzword that will confuse the beginner?
- OS environment running the sample code e.g. Linux
or Win 
or Win - 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?
