Hrk Solution > Solution > Documentation

Documentation

Outline
The stages of our documentation process are planning, designing, writing, reviewing, and editing. We deliver the following types of documentation:

	Instructional and reference documentation - online or offline help, usage and installation instructions, cheat sheets, manuals, glossaries, and troubleshooting texts;
	Interface texts – labels, menus, buttons, in-built instructions, and messages;
	Tutorials and training materials – guides and tutorials for self study or materials for in-class training complete with instructional texts, tips, exercises, and exams;
	Demos and presentations – films demonstrating the product interface and usage flow or static presentations with product feature lists and screenshots.

Skills

Our technical writers have good to excellent understanding of the writing process, excellent English, and good technical aptitude. In terms of experience, we qualify our technical writers as:

	Beginner – people having no or limited (up to 3-4 months) experience on the job. They have at least gone through training for technical writers.
	Intermediate – people with some experience. They have completed at least two projects. Their experience on the job ranges from a few months to 2 years.
	Senior – people with significant experience and knowledge in the field. They have more than 2 years on the job and a number of different writing projects.
	Master – people with proven record of successful writing projects. They have practice of 6 and more years on the job. Their extensive experience and judgment allow them to plan and accomplish goals. They also lead, mentor, and direct the work of others.

Training

Outline

We train people with no or little experience in the field of technical writing and help them acquire basic knowledge and gain some practical skills. Our general introductory course balances theory with practical exercises. The theoretical part gives participants the framework of technical writing, basic concepts, and guidelines. It also points to further resources and materials. The exercises offer participants a chance to practice their skills and receive personal feedback on their work.

Format

Know and do workshop includes theory and practice. Each session ends with the application of acquired skills. The practical exercises can be adjusted to meet specific needs or be drawn from a specific domain.