User Story #7010 (closed)
Opened 12 years ago
Closed 12 years ago
Websites documentation and organization
Reported by: | jburel | Owned by: | wmoore |
---|---|---|---|
Priority: | major | Milestone: | OMERO-4.4.4 |
Component: | Documentation | Keywords: | n.a. |
Cc: | ajpatterson, saloynton, jamoore | Story Points: | n.a. |
Sprint: | n.a. | Importance: | n.a. |
Total Remaining Time: | 0.0d | Estimated Remaining Time: | n.a. |
Description (last modified by saloynton)
As part of the cleaning process,
both https://www.openmicroscopy.org/ and http://trac.openmicroscopy.org.uk need to be reviewed.
Main aims for both sites:
- Remove content that is out of date.
- For out-of-date pages, either update or move any useful content & delete
- Make sure all content is findable.
- Should be able to browse to any page, starting at the home page, in a reasonable number of logic links!
- Each page should explain what it's about (E.g. see wikipedia).
- E.g. WorkingWithOmero "This page describes various tools and resources useful for working with the OMERO API, as well as some tips on setting up your working environment. etc."
Trac e.g.
- Many pages can only be accessed from the index.
- Define 6-7(max) components that pages should come from
Openmicroscopy: e.g.
- Duplicate documentation training material vs tutorial
This story is the umbrella ticket.
Reference Material:
http://www.smashingmagazine.com/2010/03/17/starting-out-organized-website-content-planning-the-right-way/
Attachments (1)
Change History (8)
comment:1 Changed 12 years ago by wmoore
- Description modified (diff)
Changed 12 years ago by saloynton
comment:2 Changed 12 years ago by agilo
- Status changed from new to accepted
Updated status, related task in progress
comment:3 Changed 12 years ago by jburel
- Cc jmoore added
comment:4 Changed 12 years ago by saloynton
- Description modified (diff)
comment:5 Changed 12 years ago by jmoore
- Milestone changed from OMERO-Beta4.4 to OMERO-Beta4.4.x
comment:6 Changed 12 years ago by jmoore
- Milestone changed from OMERO-4.5 to OMERO-4.4.4
Moving this into the current milestone, since we're doing much of this now anyway.
comment:7 Changed 12 years ago by sbesson
- Resolution set to fixed
- Status changed from accepted to closed
All goals achieved. Only remaining task (sphinx policy) will be done in 4.5
A content inventory example. This is a way to understand the breadth of your website and the purpose of each page. Example spreadsheet attached we may use as a template.