Concept
We provide support for the entire technical documentation workflow—from vulnerability analysis through content and layout concepts to your customized editorial guidelines.
With well-thought-out concepts, tecteam ensures effective and efficient editorial processes.
Vulnerability Analysis
Do you need help creating or improving your technical documentation? We analyze your existing documentation and evaluate it with regard to:
- Target Audience Focus
- Completeness of the Information
- Outline Structure
- Comprehensibility of Text and Images
- Typography and Layout
- Compliance with Standards, Guidelines, and Legal Requirements
You’ll gain a comprehensive overview of the opportunities for improvement available to you. You’ll benefit from our many years of experience: We know that our customers’ diverse needs and preferences require customized solutions for specific markets.
Content and Layout Concepts
We’ll clarify your needs and preferences for successfully defining goals by asking the following questions:
- What needs to be documented?
- In what format must the documentation be provided?
- What legal and regulatory requirements must be met?
- What are the competitors doing?
In addition to defining your goals for coherent content and layout concepts, you need to determine how you plan to achieve these goals.
The following questions can be helpful in this regard:
- Can we keep doing things the way we have been?
- What can we do better?
- What means and methods are available to us?
- What processes and structures are necessary for this?
- What costs can we expect?
Workflow
Regardless of the type of manual or the medium you choose, we’ll support you by providing content creation and consulting services throughout the entire technical documentation workflow. The entire editorial process is guided by proven criteria.
- Responsibilities
- Interfaces with Other Business Units
- Technical Approval Processes (Review Definitions)
- Translation Workflows
- Quality Assurance and Proofreading
- Editorial Approval Processes
Editorial Guidelines
To serve as a foundation for your editorial work, you will receive an editorial guide that describes all the steps, processes, procedures, etc., necessary to ensure consistent, high-quality work in technical documentation. This editorial guide defines all the quality criteria for an effective and efficient editorial process:
- Typography and Layout
- Structure
- Writing Style
- Text Standards
- Visualization
- Symbols
- Colors