-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This is a wiki for systems developed under IOStream-OpenEnd initiative. This place hosts all the reports, discussions between collaborators, and design decisions on one or various projects under IOStream-OpenEnd (until a better, dedicated alternative is found).
Because documentation is as important as writing code. The importance of a "Knowledge Base" cannot be overstated in success of any organisation (be it open source or not).
For a programmer reliable documentation is always a must. The presence of documentation helps keep track of all aspects of an application and it improves on the quality of a software product. Its main focuses are development, maintenance and knowledge transfer to other developers. Successful documentation will make information easily accessible, provide a limited number of user entry points, help new users learn quickly, simplify the product and help cut support costs. Documentation is usually focused on the following components that make up an application: server environments, business rules, databases/files, troubleshooting, application installation and code deployment.
We are still working on this. Ideally, this system should have a repo structure where any changes can be done through pull requests etc. However, this is not of prime importance right now, as knowledge transfer is for the most part our primary goal. If you have been given access to this wiki, and are wondering how to write great KB articles (which in itself is an art), you may find yourself really liking this article: https://www.livechatinc.com/blog/knowledge-base-article/
A few good examples of kb articles and how your articles should be written:
- https://docs.microsoft.com/en-us/previous-versions/dynamics-crm2011/developers-guide/gg328350(v%3dcrm.5)
- https://wiki.apertus.org/index.php/AXIOM_Beta/Software_Installations
- https://wiki.apertus.org/index.php/AXIOM_Project_Background
(Complete this section)