ocPortal CEDIWelcome to the ocPortal Community Edited Documentaion Initiative. This is a community documentation where we encourage everybody in the ocPortal community to:
- produce your own tutorials, or share your own extensions to the tutorials produced by the core ocProducts team
- feedback your own specific comments on where documentation could be improved
This way we will all be able to work together to improve documentation for everyone.
A common feedback received by ocPortal users is that the official documentation is terse and usually doesn't step through tasks in a very clear way. This is a fair comment, as the documentation is produced by a small core team and designed to explain features in the most generic way (the common denominator of usage).
This crowd-sourced community documentation has the potential to go into much more detail, and to explain specific scenarios.
So please, think positively, the more people who add to this documentation, the better things are for everybody.
There are no specific 'rules' on how to produce documentation, although certainly some community guidelines will be agreed on within the community as time goes on. We operate on a principle very similar to Wikipedia, although the documentation here is to help people achieve tasks rather than just merely to establish facts.
To get started, either:
a) view the documentation tree
b) or, choose a child page (category) from below:
- Installation and configuration (4 posts, 4 children)
- Video tutorials (10 children)
- Introduction and background information (empty)
- General (non-ocPortal-specific) guides (1 post)
- Core ocPortal structure (2 posts)
- On-going configuration and maintenance (5 posts)
- Integration configuration (empty)
- Advanced configuration (5 posts, 2 children)
- Configurational events (1 child)
- Advice and guidance (2 posts)
- Content features and usage (2 posts, 2 children)
- Miscellaneous features and usage (10 posts, 1 child)
- User features and usage (empty)
- OCF features and (Forum/Members) usage (3 posts, 1 child)
- Visual customisation (17 posts, 4 children)
- Progmattic customisation (2 posts, 19 children)
- Documentation Requests (empty)
- Reporting feedback (1 post, 4 children)
- Business advice (1 post)
- (Documentation translation) (empty)
Submitted by Chris Graham
ocPortal.com - View topic: Community documentation
One great thing about community documentation is that often people from the community can explain things much more clearly than ocPortal developers can, due to the neutral perspective. By creating a technology one is biased in ones perspective on it, making it very hard to articulate things that make sense to a new learner. ocPortal developers are really looking forward to seeing task-based tutorials, which we traditionally haven't been able to do so well as feature-based ones, unless we've spent days to write/record them.
We have set up the community documentation with wiki-like permissions – i.e. everyone has permission to change everything.
ocProducts is not going to dictate how the documentation should be structured. From our perspective we are happy if people post links to off-site documentation, although inline documentation is preferable if it is possible.
There is a category for .