Forums

Sign in

E-mail *, (xx@domain.com)
Password *

Register | Forgot password

Active forums

Active Forums RSS February 07, 10:55
I18n

February 03, 17:26
Fertching data from a web service

February 03, 10:24
Thesaurus parent-child relationship

January 31, 10:52
The desired archetype does not exist

January 30, 17:40
installing from scratch on linux from sdk

 All Forums...


Organization of the documententation section

 

Answered
Not marked as answered yet

Forums  >  Connect  >  Organization of the documententation section


Author Organization of the documententation section
williamb



Posts: 310

Posted: 25-03-2010 21:35

Would it be an idea to organize the documentation based on the point of view of the reader?

E.g. Introduce the following 'point of view groups'

- Content Editing
- Content Editing (government)
- Application Managing
- Designers & Design Implementation
- Backend Java developing
- System administrating

And order the documentation inside those 'groups' based on their importance if you start with GX WebManager.

E.g.
- Content Editing
* Quick Reference Guide (GXD0064)
* Content Management - Basic (GXD0001)
* Content Management - Advanced (GXD0002)
* News (Archives & Overviews) (GXD0003)
* etc.

- Content Editing (government)

- Application Managing

- Developers
* Installation of a local development environment (GXD0071)
* Quick Start Eclipse (GXD0098)

- Developers: Designers & Design Implementation
* Design API (GXD0051)
* Tag Library Quick Reference (GXD0085)
* Javadoc (GXD0091)
* Website Design Guidelines (GXD0062)

- Developers: Backend Java developing
* WCB Development - Quick start (GXD0055)
* WCB Development - Tutorial (GXD0056)
* WCB Development Guidelines (GXD0073)
* WCB GUI Guidelines (GXD0072)

- System administrating
* etc. etc.

Back to top

New message: "Organization of the documententation section"
Message:
bold boitalicd underline url quote code smile cool eek grin mad razz sad wink
 
© 2012 GX Software B.V.

Disclaimer

This website (Connect.gxsoftware.com) may discuss or contain opinions, (sample) coding, software or other information that does not include GX official interfaces, instructions or guidelines and therefore is not supported by GX. Changes made based on this information are not supported.  GX will not be held liable for any damages caused by using or misusing the information, software, instructions, code or methods suggested on this website, and anyone using these methods does so at his/her own risk. GX offers no guarantees and assumes no responsibility or liability of any type with respect to the content of this website, including any liability resulting from incompatibility between the content of this website and the materials and services offered by GX. By using this website you will not hold, or seek to hold, GX responsible or liable with respect to the content of this website.