Technical writing and content structuration
training course for beginners
A technical writer is tasked with creating technical or specialized documents. He is a specialist in the drafting of techniques, as well as standards, specifications, and standards of the trade, which are applied in the fields of use, installation, or maintenance of systems, in sectors such as aeronautics, automotive, defense, etc.
You will learn the basics of technical writing and technical documentation in an industrial environment.
Our training can be held in-person or remotely.
(3,8/4)
GENERAL INFORMATION
Trainees
From 3 to 6 trainees maximum per session
Duration
2 days
Calendar
Dates on request: info@.4dconcept.fr
Price
Available on request
Target
Future technical writers, users and occasional writers of technical documentation
Prerequisites
None
All of our training can be held face-to-face or remotely.
In 2020, we adapted all our courses to the constraints of distance learning. It is now possible for you to benefit from all our expertise from anywhere, without traveling or seeing us.
Goals
At the end of the course, you will have acquired the basics of the technical writing such as:
Purpose of technical documentation standards
Editorial rules applicable to technical documentation
Stages of a documentary process
Concepts of structured and modular content
And you will know concretely:
Identify the qualities and the defects of a technical documentation
Structure technical documentation according to its audience
Write a procedure
Program
1. Introduction to technical documentation
- Goals
- Challenges
- Quality
- Improvement
2. Basic Concepts
- Basic principles
- Business standards
- Structured documentation standards
3. Editorial rules
- The right word
- Style
- Syntax
- Terminology
- Punctuation
- Spelling
- Simplified English
4. Documentation process
- Life cycle of a documentary project
5. Structured content & documentary
- Introduction
- Traditional documentation
- Get out of the traditional
- New uses
- Transition to SGML
- HTML
- Other challenges
- Solution: modularization
- Switch to XML
Practical work
- The exercises include throughout the course:
- Technical writing
- Data analysis
- Writing in structured documentation
—
Assessment methods:
The evaluation of the achievements will be carried out by the trainer at the end of the course.
Update January 2022
Handicap accessible
4D CONCEPT is committed to making training available to everyone.
Our centers are accessible to people with reduced mobility, and our teams are responsible for providing the best possible support to participants with disabilities, whatever they may be, throughout their training course.
Please contact us at the following address psh-accueil@.4dconcept.fr to better understand your request and its feasibility.
