Writing the technology article: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (→Checklist) |
||
| 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? | ||
Revision as of 14:06, 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?
- 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?