ICAICT408: Create Technical Documentation - Tafe New England Portfolio Assignment Help

Internal Code : 1AAECJ

Portfolio Assignment Help

TASK

1. Define the terms “Clarity” and “Readability”.
2. Outline the principles of:

• Document design
• web design
• Usability

3. Explain the functions and features of templates.
4. Explain the functions and features of style guides.
5. Explain instructional design principles.
6. List organisational policies, procedures and standards that cover document design.
7. List three questions that you might ask a client during initial consultation to identify their documentation requirements.
8. The client has requested that the documents:
   • Be easy to read so good clear fonts

• Simple to understand no unnecessary jargon
• Be based on a template that ensues a consistent look

Interpret and evaluate these requirements (what will you do to ensure that the client requests will be met?)

12. Forward your interpretation to the client (your teacher) for confirmation of the details.
13. Once the basic details have been confirmed email your client (your teacher) again defining the scope of the work to be produced. (What exactly you will and will not create for the client under this project). Obtain confirmation of the scope of the project.
14. You have agreed to create a Style Guide for the client. Research the internet for current industry standards for Style Guides and documentation standards. Include two web site addresses for each.
15. Identify information requirements with reference to layout and document structure. Include a hand drawn draft.
16. Conduct a review of the system to be documented in order to understand its functionality.
17. Extract content that meets information requirements according to copyright restrictions.
18. Translate technical terminology into Plain English
19. Develop the structure of the technical documentation giving focus to the flow of information, style, tone, and content format. Submit to your client for approval.
20. Develop a Style Guide for the client following current industry standards found in your research. This Style Guide should cover at least the following giving font style, font size, indents or placement:

• Headings and sub-headings
• Body text
• Bulleted lists
• Numbered lists
• Footers
• Abbreviations and acronyms

18. Produce a template document containing all of the styles in the style guide. If undertaking web based documentation this could be a CSS or similar. Name this appropriately.

Include a copy in your portfolio.

19. Write technical documentation based on the template and scope of work using the information gathered. This may be created from scratch or created by pasting in information from documents already completed and applying the template and styles you have created.
20. Submit your technical documentation to your client (teacher) for review.
21. Analyse the feedback from your client and incorporate any necessary alterations into the technical documentation. Editing as necessary to ensure that documentation is technically and grammatically correct.
22. Double check that documentation meets client needs and scope of work.
23. Submit to client (your teacher) for final approval

Prepare the technical documentation for publication and distribution using appropriate channels. The above question has been solved by  our Technical Documentation experts at onlineassignmentbank. Our Assignment Writing Experts are efficient to provide a fresh solution to this question. We are serving more than 10000+ Students in Australia, UK & US by helping them to score HD in their academics. Our Experts are well trained to follow all marking rubrics & referencing style.