[jbosstools-issues] [JBoss JIRA] Commented: (JBDS-907) Guides restructuring

[Michael Sorokin (JIRA)]

    [ https://jira.jboss.org/jira/browse/JBDS-907?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12493517#action_12493517 ] 

Michael Sorokin commented on JBDS-907:
--------------------------------------

I absolutely agree with you, Olga.
To sum up your idea:
*All procedural operations must be put into the "Task" chapter.  Each section of the chapter is a tutorial on a particular topic.
*The referential data should be stored in the "Reference" chapter.

However, I should say that it is conventionally correct to capitalize all meaningful words in titles and headings.  


> Guides restructuring 
> ---------------------
>
>                 Key: JBDS-907
>                 URL: https://jira.jboss.org/jira/browse/JBDS-907
>             Project: JBoss Developer Studio
>          Issue Type: Task
>          Components: documentation
>    Affects Versions: 2.1.0
>            Reporter: Svetlana mukhina
>            Assignee: Michael Sorokin
>             Fix For: 2.1.0-doc
>
>   Original Estimate: 1 week
>  Remaining Estimate: 1 week
>
> New, more convenient and informative guides structure should be worked out.
> As an example you can use Dali Documentation - e.g. http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse.jpt.doc.user/reference017.htm - Dali Java Persistence Tools User Guide

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira