[
https://issues.apache.org/jira/browse/OFBIZ-6015?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14282960#comment-14282960
]
Ron Wheeler commented on OFBIZ-6015:
------------------------------------
Topic-based writing seems like a good way to build documentation and encourages
reuse rather that copy and paste.
Splitting up the documentation into sections based on screens/business
processes with concepts as separate fragments will make the use of the
documentation for various purposes (on-line help, program specifications,
training, manuals, job-aids, etc.) much easier.
It may also encourage developers and business consultants to contribute
fragments from user requirements, design specifications or even design
discussions that can be used to construct documents.
The big issue here is naming and tagging fragments so that it is easy to find
the pieces that you want.
The initial suggestion about using the SCM (SVN) to store them only works if
the documentation team has write access and can manage the structure of the
fragments easily. A CMS would be a better choice. If the document production
steps can support access to fragments in the CMS, that would be ideal.
> Move Online Help Documentation from Webhelp into Trunk
> ------------------------------------------------------
>
> Key: OFBIZ-6015
> URL: https://issues.apache.org/jira/browse/OFBIZ-6015
> Project: OFBiz
> Issue Type: Improvement
> Components: ALL APPLICATIONS
> Reporter: Sharan Foga
> Assignee: Sharan Foga
> Priority: Minor
>
> This Jira has been created to manage the migration of all the documentation
> from the Webhelp branch into the current help system so that it will work
> with what we already have (essentially so that we dont lose it!). The
> original issue for the Webhelp is
> https://issues.apache.org/jira/browse/OFBIZ-4941
> As well as HR, there is also online documentation for Accounting,
> Manufacturing (English, German and Dutch), Project Manager and Catalog -
> though not as complete, so I will be consolidating and moving those too.
> The files use the docbook format and are compatible with what we have
> although he implemented everything into one file whereas we use one file per
> screen - so I'll need to split it up.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
