Software Documentation: Difference between revisions
extracting and expanding on the content that was previously in the 'API' article. |
No edit summary |
||
| Line 42: | Line 42: | ||
* info:/dir (type this into the location bar of Konqueror) browse the Info system. You can of course type "info" in your shell, but I find that browsing "info" through Konqueror is a lot nicer. | * info:/dir (type this into the location bar of Konqueror) browse the Info system. You can of course type "info" in your shell, but I find that browsing "info" through Konqueror is a lot nicer. | ||
* man:/command (type this into the location bar of Konqueror) browse the Man system. You can of course type "man command" in your shell, but I find that browsing "manuals" through Konqueror is a lot nicer. | * man:/command (type this into the location bar of Konqueror) browse the Man system. You can of course type "man command" in your shell, but I find that browsing "manuals" through Konqueror is a lot nicer. | ||
== Documentation Documentation == | |||
OK, so you've adopted all kinds of tools, and procedures for documentation, and you've got multiple people actually writing or contributing to your project's documentation... Great! That means you need some documentation about how you document things :-) Examples: | |||
* http://www.open-emr.org/wiki/index.php/How_to_Document_Your_Code_Properly | |||
[[Category:Applications]] | [[Category:Applications]] | ||