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 Portfolio Management application.
2. Open the record (Idea, Demand, Project, Sprint, Phase, Task, Program,  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 from the dropdown.
   Index	Enter the position number at which you want to place the document. This field helps maintain the indexing of documents.
   Summary	Enter a summary to describe the objective of the Document.
   Visible in Portfolio	Select from: Yes or No. If selected Yes, the document will be listed on the related tab of the portfolio.

5. Click Create. The new document is created in Draft status.
6. To add the details of the document, click on Summary from the list.

7. 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	Click to add an attachment. For example, you can associate videos for more information on documents.

8. Click Save. Once required information based on document type is added it goes into Defined status.