Describe Your Participation in a Documentation Effort

The App: The development team developed a mobile App for worldwide practitioners to practice meditation. The practitioners can: register for upcoming meditation courses; record their everyday meditation practice; write journals to reflect on their practicing results; watch online videos from previous classes; download massive meditation instructional videos and music; offer lights for their loved ones; and more. What I Did: I participated in the documentation project of this mobile App.

The 29 Steps of a Documentation Project

Here is a traditionally recommended general sequence of the 29 steps for a documentation project: Discuss the need for the document with your client. Determine the purpose and objectives of the document. Talk to intended users of the documents. Profile the users’ information needs. Prepare an outline of the planned contents of the documents Design the layout of the document. Plan the online version of the document. Prepare style guidelines or a style sheet.

A Writing Sample: Aegisub Quick Start

Aegisub Quick Start (https://aegisubquickstart.wordpress.com/) As an excellent subtitle-adding software, Aegisub has been used intensively in my company’s video production team. However, its official tutorial is highly text-intensive with little graphics, so training new team members took lots of time and effort. My task was to create a Quick Start manual to help beginners start quickly and save time and effort for training. I started by reading the original online manual; it was difficult to understand (perhaps they didn’t have a sufficient budget for documentation).