Welcome, Guest: 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) - Programming - Nairaland

Nairaland Forum / Science/Technology / Programming / Software Documentation (Technical Writing) (187 Views)

Free PHP, Node js ,Mongo db, Angular And C# Proje Source Code With Documentation / Software Documentation / Paystack Are The Best In API Documentation So Far (2) (3) (4)

(1) (Reply) (Go Down)

Software Documentation (Technical Writing) by Nature129(m): 1:08pm On Mar 30
Hi Guys,

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.

1 Like

Re: Software Documentation (Technical Writing) by Nature129(m): 2:54pm On Mar 30
Karleb:
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.

Can you train me?
Re: Software Documentation (Technical Writing) by Karleb(m): 2:57pm On Mar 30
Nature129:


Can you train me?

Yes. If you can pay $10/hr. cheesy

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
Karleb:


Yes. If you can pay $10/hr. cheesy

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?

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
Nature129:


No, I am not a coder

However, I tend to be one.

So, I cannot document software without the coding knowledge?
No na!
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
spartan117:

No na!
But I'm curious to know what makes you more interested in documenting software rather than building the software itself

Yeah because some codes can be obscure, like Java Documentation , you need some basic coding background at least

1 Like

(1) (Reply)

How Mobile Application Development Processes Help Your Business? / Free Browsing Cheats For Mtn ��, Airtel ��, 9mobile, Ntel And Smile �� / Please I Need Help With This Array

(Go Up)

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

Links: (1) (2) (3) (4) (5) (6) (7) (8) (9) (10)

Nairaland - Copyright © 2005 - 2021 Oluwaseun Osewa. All rights reserved. See How To Advertise. 41
Disclaimer: Every Nairaland member is solely responsible for anything that he/she posts or uploads on Nairaland.