Writing the technology article
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
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.