Dashboard > Admin > Home > 05 Online Help > 03 Concepts Writing Guidelines
03 Concepts Writing Guidelines Log In | Sign Up   View a printable version of the current page.

Added by Administrator , last edited by Administrator on Jan 31, 2008
Labels: 
(None)

High-Level description of ideas, architecture. Provides background information to understand what is going on.

Checklist

  • you can include images and diagrams
  • similar to writing articles
  • Wait for the user list to ask what and the describe with a concept page

Good Examples

Comments

Conceptual topics present an in-depth discussion of ideas, architecture, technologies, solutions, or processes. Concepts are high-level descriptions of the schema and functions of the plug-in tool. This section helps provide a general understanding of how the plug-in functions. For example, in the Workbench User Guide, the Concepts section includes a discussion of what perspectives and views are and how they relate to one another.

Additionally, conceptual topics should not contain procedures, which are documented in task topics (Tasks section). Therefore, use conceptual topics to provide a comprehensive discussion of the processes or options behind a procedure, and include links to related task topics.

Powered by a free Atlassian Confluence Open Source Project License granted to uDig. Evaluate Confluence today.
Powered by Atlassian Confluence 2.7.1, the Enterprise Wiki. Bug/feature request - Atlassian news - Contact administrators
User-friendly Desktop Internet GIS