[NeXus-definitions-tickets] [NeXusDefinitions] #146: reactivate key wiki pages that document NeXus

[NeXus Base Classes and Instrument Definitions]

#146: reactivate key wiki pages that document NeXus
-------------------------+--------------------------------------------------
 Reporter:  Pete Jemian  |       Owner:  Pete Jemian
     Type:  defect       |      Status:  assigned   
 Priority:  major        |   Milestone:  later      
Component:  general      |    Keywords:             
-------------------------+--------------------------------------------------
Changes (by Pete Jemian):

  * component:  => general
  * milestone:  release NXDL 1.0 => later


Old description:

> For the person who is browsing the NeXus casually, the transition from
> WWW site to the manual documentation in HTML or PDF is too abrupt.
> Especially since the manual documentation does not provide copious links
> back to other WWW site content.  (Looks like an abrupt one-way exit from
> the WWW site.)
>
> Need to reactivate (and update) key wiki pages that provide overview and
> introductory content.  In those pages, describe clearly when a link will
> open the manual documentation.
>
> It is important to note:
>  1. the WWW pages should be contemporary with the manual documentation
>  1. the needs of a WWW page are different than those of a manual
>  1. The DocBook manual was constructed to respond to community demand for
> better documentation
>   * Development of NeXus documentation on the wiki became chaotic.
>   * Participation to revise the manual from the community was not strong
>   * This made it difficult for newcomers to understand NeXus.
>
> Consider that each manual chapter could have its own wiki page.  This
> might be the first step at cross-organization of this content.

New description:

 For the person who is browsing the NeXus casually, the transition from WWW
 site to the manual documentation in HTML or PDF is too abrupt.  Especially
 since the manual documentation does not provide copious links back to
 other WWW site content.  (Looks like an abrupt one-way exit from the WWW
 site.)

 Need to reactivate (and update) key wiki pages that provide overview and
 introductory content.  In those pages, describe clearly when a link will
 open the manual documentation.

 It is important to note:
  1. the WWW pages should be contemporary with the manual documentation
  1. the needs of a WWW page are different than those of a manual
  1. The DocBook manual was constructed to respond to community demand for
 better documentation
   * Development of NeXus documentation on the wiki became chaotic.
   * Participation to revise the manual from the community was not strong
   * This made it difficult for newcomers to understand NeXus.

 Consider that each manual chapter could have its own wiki page.  This
 might be the first step at cross-organization of this content.

--

-- 
Ticket URL: <http://trac.nexusformat.org/definitions/ticket/146#comment:2>
NeXus Base Classes and Instrument Definitions <http://www.nexusformat.org/>
NeXus Base Classes and Instrument Definitions