TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Uniform processes and designs through an editorial guide
Subject:Uniform processes and designs through an editorial guide From:"Riese, Claudia" <CRiese -at- tunstall -dot- de> To:"techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 16 Feb 2021 09:25:33 +0000
Hi everyone,
I have the task of creating a so-called editorial guide. That is already my first question. I don't really know what the so-called editorial guide is actually called in English.
First of all, I would like to explain my task in more detail: A company has locations in several countries. Products are developed at the different locations and documented by technical writers. Until now, the technical writers have worked independently of each other. This is to change. The processes at the different locations are to be standardised. The design of all manuals and online help should be the same. It is a long way until then.
The processes are to be described in the so-called editorial guidelines. In addition, design specifications are to be made in the editorial guide. It is to become a tool that is continuously updated.
In the past, editorial guides were manuals, i.e. PDF files. But I don't think that's up to date any more. I want to make the guide available online for the technical writers. Everyone should have the right to write. It could be a wiki, for example.
I have the following questions:
1. what is the correct name for an editorial guide in English?
2. do you have any experience with editorial guides?
3. on what basis is an editorial guide that you know or would recommend? Wiki? Other idea?
4. can you show me an example?
Thanks in advance,
Claudia
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com
