[richfaces-issues] [JBoss JIRA] Updated: (RF-2121) Doc Requirement for QA

[Svetlana mukhina (JIRA)]

     [ http://jira.jboss.com/jira/browse/RF-2121?page=all ]

Svetlana mukhina updated RF-2121:
---------------------------------

    Description: 
Here is a list of requirements that should be followed during docs testing procedure:
1. Everything that written in guide should work exactly as it's written 
2. All functionality should be described, if something is missing it means a bug in docs
3. Screenshots should be user-friendly and lifelike
4. Technical Requirements should be always up-to-date
5. Code samples should be workable
6. Complicated code samples should have descriptions
7. Text should be understandable and not confusing
8. Pay attention not only to content, but also to format: incorrect symbols, unnecessary spaces, improper font, ambiguities highlighting, broken links, etc.  
9. Chapter, section and even sentences should go in logical order 

  was:
Here is a list of requirements that should be followed during docs testing procedure:
1. Everything that written in guide should work exactly as it's written 
2. All functionality should be described, if something is missing it means a bug in docs
3. Screenshots should be user-friendly and lifelike
4. Technical Requirements should be always up-to-date
5. Code samples should be workable
6. Complicated code samples should have descriptions
5. Text should be understandable and not confusing
6. Pay attention not only to content, but also to format: incorrect symbols, unnecessary spaces, improper font, ambiguities highlighting, broken links, etc.  
7. Chapter, section and even sentences should go in logical order 


> Doc Requirement for QA
> ----------------------
>
>                 Key: RF-2121
>                 URL: http://jira.jboss.com/jira/browse/RF-2121
>             Project: RichFaces
>          Issue Type: Task
>          Components: doc
>    Affects Versions: 3.1.0
>            Reporter: Svetlana mukhina
>         Assigned To: Tsikhon Kuprevich
>             Fix For: 3.2.0
>
>
> Here is a list of requirements that should be followed during docs testing procedure:
> 1. Everything that written in guide should work exactly as it's written 
> 2. All functionality should be described, if something is missing it means a bug in docs
> 3. Screenshots should be user-friendly and lifelike
> 4. Technical Requirements should be always up-to-date
> 5. Code samples should be workable
> 6. Complicated code samples should have descriptions
> 7. Text should be understandable and not confusing
> 8. Pay attention not only to content, but also to format: incorrect symbols, unnecessary spaces, improper font, ambiguities highlighting, broken links, etc.  
> 9. Chapter, section and even sentences should go in logical order 

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