ITA

ITA Documentations Sub-Team

Registered by <Geek/>

ITA Documentation Team objectives:

Documentation is an important part of system/software projects, types of documentation that

our team could provide:

1. End user documents: describe the functionality of the system/software and each

feature, and assist the user of realizing these features.

There are three parts in which user documentation can be organized:

1.1 Tutorials: an approach is considered the most useful for a user, in which they are

1.2 List of references: an approach in which command or tasks are simply listed in the

1.3 Design: an important part on how users will consider using the documents or how

guided thought each steps of the system/software.

document.

will interact with it, simplify the documents and using a good functionality will help

the user to find subject, task, and information.

2. Marketing Documentation: it is necessary to have some promotional materials to

encourage people to spend more time learning about the system/software, one good

marketing technique is to provide clear catch phrases that simplify the point we wish to

explain,

Marketing documentation has three reasons to use:

2.1 To excite the users about the product and desire to be more involved with it

2.2 To inform users what the product does.

2.3 To explain the position of a product with respect of other products

Future objectives for ITA Documentation Team:

Technical documentation: is a documentation of code/interface, when creating of product

there must be description of intended operation, several how-to and overview documents are

found for the software application/product, this documentation maybe used by developer,

testers and also the end customers.

Blueprint information

Status:
Not started
Approver:
None
Priority:
High
Drafter:
<Geek/>
Direction:
Approved
Assignee:
ICSF Docs
Definition:
Approved
Series goal:
None
Implementation:
Not started
Milestone target:
None

Related branches

Sprints

Whiteboard

(?)

Work Items

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.