Creating documentation documents

A documentation document helps to capture, and explain some attributes of a requirement or a procedure. The main purpose is to describe the use, operation or design of software or hardware through the use of manuals and diagrams.

This topic guides you on how to submit and edit documentation documents.

To create and edit a documentation document

1. Log in Agility Suite application.
2. Open the record (Idea, Demand, Project, Sprint, Phase, Task,  Portfolio and Requirement), where you want to create the new document.
3. Go to the Related tab and click 'New'.

4. On the Create Document page, enter the values for the following fields: 

   Field	Description
   Document Type	Select Documentation.
   Index	This field allows maintaining the indexing of documents.
   Summary	Enter a Summary of the Document which will describe the objective.
   Visible in Portfolio	Values: Yes, No. If 'Yes', the document is listed on the related tab of the portfolio.

5. Click 'Create'.
6. The new document is created in 'Draft' status.
7. For adding the details of the document, click on Summary from the list.

8. On Specify Document page details, add the data required in the corresponding fields: 

   Field	Description
   Detailed Description	Enter details of the Document based on its purpose.
   Attachments	Can associate attachments, and videos for more information on documents.

9. Click on the Save action button to save the changes. Once required information based on document type is added it goes into Defined status.