Good documentation is essential to understanding an application and no application is complete without it. Realistically though, for most projects adequate documentation is more achievable.
The recently updated SharpForge user documentation now describes common tasks with screen-shots for end users of the web application. This includes project users, project administrators and portal administrators. It can be found any time from the project wiki. The documentation is broken down into the major components.
- Projects - What is a project and what does it do for me
- Release Management - Communicate and distribute software releases to users
- Wiki - Simple html content management system for project documentation. ( requires Subversion )
- Work Items - tracks work required to perform tasks, by who, when, how etc. Users can vote to help prioritize work
- Forums - communication via thread messages
- Web Chat - simple online chat
Not quite finished are….
- Portals - SharpForge’s design allows multiple websites to co-exist and even share users.
- Subversion - How do SharpForge and Subversion talk
Any feedback good, bad or ugly is all welcomed.
