|Join Nairaland / LOGIN! / Trending / Recent / New|
Stats: 2,755,026 members, 6,544,846 topics. Date: Tuesday, 19 October 2021 at 12:28 AM
|Software Documentation (Technical Writing) by Nature129(m): 1:08pm On Mar 30|
I trust you all are doing great.
Any software documentation expert in the house? Please how did you acquire the skill?
Please I want to learn Software Documentation, so I am looking for a place where I can acquire the skill. I am currently in Lagos (Island axis).
Any suggestions, please?
|Re: Software Documentation (Technical Writing) by Karleb(m): 2:34pm On Mar 30|
The best way to learn how to write documentation is to read documentations like your life depends on it.
Then have some samples of your work. Maybe rewrite a popular documentation or write documentation for a code you've written yourself.
You have to be a developer and be also familiar with the code you want to document though.
|Re: Software Documentation (Technical Writing) by Nature129(m): 2:54pm On Mar 30|
Can you train me?
|Re: Software Documentation (Technical Writing) by Karleb(m): 2:57pm On Mar 30|
Yes. If you can pay $10/hr.
Can you write and run programs?
Don't be deceived. You can't write documentation without the knowledge of what you want to write about.
Laravel documentation for example was written by the author himself. Shey you get?
|Re: Software Documentation (Technical Writing) by Nature129(m): 3:03pm On Mar 30|
No, I am not a coder
However, I tend to be one.
So, I cannot document software without the coding knowledge?
|Re: Software Documentation (Technical Writing) by spartan117(m): 5:00pm On Mar 30|
But I'm curious to know what makes you more interested in documenting software rather than building the software itself
|Re: Software Documentation (Technical Writing) by qtguru(m): 7:27pm On Mar 30|
Yeah because some codes can be obscure, like Java Documentation , you need some basic coding background at least
|Sections: politics (1) business autos (1) jobs (1) career education (1) romance computers phones travel sports fashion health |
religion celebs tv-movies music-radio literature webmasters programming techmarket
Nairaland - Copyright © 2005 - 2021 Oluwaseun Osewa. All rights reserved. See How To Advertise. 41