Help Me In documentation

Question

0.00/5 (No votes)

See more:

Hi All,
i am a freelancer and now i want to keep documentation of my software can any one provide me the formats for documentation .
thanks in advance

Posted 14-Jan-12 4:18am

Vijay Kr Sharma

Add a Solution

2 solutions

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

thatraja · Answer 1 · 2012-01-14T05:20:00

Solution 1

Check ReadySET[^], also read about Software documentation[^] at wiki

Posted 14-Jan-12 5:20am

thatraja

Comments

Sergey Alexandrovich Kryukov 14-Jan-12 16:10pm

Useful information, my 5.
And I recommended what I like to use, Wiki which comes with Trac, please see my answer.
--SA

Sergey Alexandrovich Kryukov · Answer 2 · 2012-01-14T10:09:00

My favorite way of doing documentation is Wiki. And my favorite way of using Wiki (even though it it pretty much rudimentary) is the Wiki integrated and bundled with Trac, issue control and project management tool. It also integrates Subversion nicely.

Please see:

http://en.wikipedia.org/wiki/Wiki[^],
http://en.wikipedia.org/wiki/Comparison_of_wiki_software[^];

http://en.wikipedia.org/wiki/Trac[^],
http://trac.edgewall.org/[^],
http://en.wikipedia.org/wiki/Bugtracker[^],
http://en.wikipedia.org/wiki/Comparison_of_issue_tracking_systems[^],
http://en.wikipedia.org/wiki/Comparison_of_project_management_software[^];

http://en.wikipedia.org/wiki/Subversion_%28software%29[^],
http://subversion.apache.org/[^].

—SA