User Documentation Writing Guidelines

User Documentation is actually our second chance to make a good impression, it will be read after a user has downloaded GeoServer and poked through the Demos (best case), or when something has gone wrong.

The second senario for user documentation is that of reference, either used as context sensitive help directly from the GeoServer application, or consulted when the user wants to accomplish a specific task.

Documentation Goals

Initial Goals
1. Install GeoServer
2. Evaulate GeoServer

Secondary Goals
3. Deploy existing spatial data
4. Customize Presentation SLDs

Advanced Goals
5. Spatial WFS-T editing
6. WFS-T Validation

Mandate

Mandate for User Documentation:

  • Walkthrough - installation & demo
  • Reference - installation
  • Reference - Target for in documentation Help

Documentation Targets

Target User

  • New to J2EE and deployment
  • New to OGC (WFS and WMS)
  • Some spatial experience
  • Windows User
View • Attachments (0) • Info