elfuchsjekyll / vosao

Automatically exported from code.google.com/p/vosao
0 stars 0 forks source link

Doc - Document outline suggestions #79

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Reviewing the documentation, I'd like to resolve some inconsistencies,
while keeping the overall structure. 

On the home page, change "Features highlighted" to "Key Features".

On the horizotal menu bar, I'd suggest we change 

it to read 

Home | Quick Start | Author | Designer | Developer | Download | Blog 

Quick Start (now About)
* Installation 
* Hosting
* Support 
- Client sites (move to main content of About page)

Key Features 
* Simple and designer friendly
* Easily extensible
* Supports multiple languages

----

Author (now Documentation)

Creating content 
* General concepts
* Next steps (was where to start)
* Tutorial (was lessons)

CMS components (steps through UI to include all authoring features)
* Content Pages 
* Site Configuration
* Plugins

----

Designer

Creating designs
* General concepts
* Next steps
* Tutorial

CMS components  (steps through UI to include all designer features)
* Design Templates
* File resources storage
* Style gallery

----

Developer 
* Project Status
* General concepts
* Next steps

Reference
* Plugins
* Velocity
* SiteMesh

Resources
* Google Code Project
* Online API documentation
* Vosao on App Gallery
* Vosao on ohloh

----

Download 

* License 

Quick Start
* Installation 
* Hosting
* Support 

----

Blog

----

Original issue reported on code.google.com by ted.husted on 1 Jan 2010 at 2:34

GoogleCodeExporter commented 9 years ago
I created an outline on CheckVist showing the changes I'd like to make. Here's 
a link
to the read-only version. 

http://checkvist.com/checklists/24251-vosao

The outline we have on www.vosao.org is sound, and we should emphasize the 
role-based
approach by having documentation categories for "Author" as well as "Designer" 
and
"Developer". Then to help keep people orientated, we can step through the UI
elements, to be sure everything exposed is documented. With a few screen shots, 
it
could also double as a product tour. 

There is some overlap around Comments and Security, which cut across several 
tabs in
the UI, but we can always cross-link to string it all together. 

Original comment by ted.husted on 2 Jan 2010 at 2:52

GoogleCodeExporter commented 9 years ago
I have a refactored version of the site outline roughed in at vosao.husted.com

The next step would be to start adding missing content. 

I'm out of town the next few days and may not have more time to work on this 
project
until the weekend, but I'm looking forward to stepping through the feature set. 

Original comment by ted.husted on 3 Jan 2010 at 6:57

GoogleCodeExporter commented 9 years ago
We have Christmas here. So I was little busy.

I like refactored version very much. Also I would like to have Contact Us page 
linked
somewhere from head or bottom section. Or maybe you have other ideas how to 
organize
users feedback.

Original comment by kinyelo@gmail.com on 8 Jan 2010 at 9:19

GoogleCodeExporter commented 9 years ago
Glad you like the refactored version. For user's feedback, aside from Contact 
Us, do
we want to enable the comments feature? Comments can be helpful on documentation
pages, so that people can add their own tips. (We just need to be sure to move 
any
fixes to the issue tracker.)

I hope you enjoyed your Christmas. We are starting to get our Christmas snow 
here.
Two inches yesterday, and 4-6" more today :) 

Original comment by ted.husted on 8 Jan 2010 at 12:42

GoogleCodeExporter commented 9 years ago
Agree on having comments on documentation pages. 

Original comment by kinyelo@gmail.com on 8 Jan 2010 at 6:29

GoogleCodeExporter commented 9 years ago
Updates are being made on vosao.husted.com

(Do we want to setup an actual staging.vosao.org site instead? No hurry, but we 
should 
move that way eventually.)

Original comment by ted.husted on 12 Jan 2010 at 2:10