info/developer-roadmap
1
0
Fork 0
mirror of https://github.com/kamranahmedse/developer-roadmap.git synced 2025-01-17 22:28:32 +01:00
Code Issues Releases Wiki Activity

Merge pull request #4876 from nsk6704/patch-1

Browse Source 
Improve readability of 'What is technical writing' section
This commit is contained in:
dsh 2024-05-09 19:49:36 +01:00 committed by GitHub
commit dc63c2e9d4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/data/roadmaps/technical-writer/content/100-introduction/101-what-technical-writing.md
View File

@ -1,3 +1,9 @@
# What is Technical Writing
Technical writing involves explaining complex concepts in a simple, easy-to-understand language to a specific audience. This form of writing is commonly utilized in fields such as engineering, computer hardware and software, finance, consumer electronics, and biotechnology. The primary objective of a technical writer is to simplify complicated information and present it in a clear and concise manner. Duties of a technical writer may include creating how-to guides, instruction manuals, FAQ pages, journal articles, and other technical content that can aid the user understanding. The ultimate goal is to enable the user to understand and navigate a new product or concept without difficulty.
Technical writing involves explaining complex concepts in a simple, easy-to-understand language to a specific audience. This form of writing is commonly utilized in fields such as engineering, computer hardware and software, finance, consumer electronics, and biotechnology.
The primary objective of a technical writer is to simplify complicated information and present it in a clear and concise manner. Duties of a technical writer may include creating how-to guides, instruction manuals, FAQ pages, journal articles, and other technical content that can aid the user understanding.
Technical writing prioritizes clear and consistent communication, using straightforward language and maintaining a uniform writing style to prevent confusion.Technical writers often integrate visual aids and leverage documentation tools to achieve these objectives.
The ultimate goal is to enable the user to understand and navigate a new product or concept without difficulty.