What are some examples of software devices
We advise and support you in achieving the best possible quality for your technical information and in optimizing your editorial processes.
Together with you we develop information, structuring and modularization concepts for the documentation of your products.
We use semantic technologies so that you can create your information efficiently and distribute it in a targeted manner.
We create your technical documentation for software, devices and machines, for example in electrical engineering, building automation, control technology, PLC programming as well as information and communication technology.
We ensure that your products are understandable, precise and fully documented so that your customers can use the products safely and optimally. We combine linguistic competence with engineering knowledge and practical experience. In this way, we can also explain technically highly complex products and functions in an understandable manner.
We take over all tasks in the creation process. If necessary, we coordinate other documentation service providers, e. B. translators or illustrators.
We create the prerequisites for you to be able to direct product information specifically to your users, appropriate to the usage situation and on the preferred end device. We help you to set up intelligent information systems.
Together with you we develop individual solutions for content and information management. We take over the necessary steps from the definition of the requirements, through the development of the information structure and the metadata model (e.g. according to iiRDS or VDI 2770), to the implementation and connection of further systems.
We analyze existing documentation if you are not sure whether it complies with the applicable guidelines or the expected quality standards.
We show you weak points and suggest specific measures for improvement. If you wish, we can optimize your documentation by incorporating the suggestions for improvement - or we can use the results of the analysis as the basis of a documentation concept in order to develop new information products.
Information products are created on the basis of a documentation concept. This concept defines the objectives of the documentation and describes the procedure according to which the information product is planned, created and made available to the users.
Together with you, we develop the appropriate documentation concept, structure the content and document the editorial processes.
In the editing process, all responsibilities, milestones and process steps from planning to archiving the technical documentation are regulated.
We support you in the development and optimization of editorial processes and in the elaboration of editorial guidelines.
All the rules for standardized editorial work are described in the editorial guide (also known as the editorial manual). It contains specifications for the design and content of your technical documentation. All processes, interfaces and responsibilities in the creation process are defined in it. The editorial guide supports your technical writers in their daily work and facilitates the training of new employees.
Together with you we develop an editorial guideline, with the specifications of which you can create your technical documentation efficiently and with consistently high quality.
In the first step, we will conduct a research interview with you. We would like to find out how and by which target group your product is used. Which documents are already available, which are still required? With this information we can estimate the scope of the project.
We then work out the documentation concept in consultation with you. We develop the structure, structure and layout of the documentation. In doing so, we take into account applicable standards and guidelines. We determine a suitable information model with which the content can be optimally structured, standardized and reused. Together with you, we create a documentation and project plan.
First, we collect the information we need. We research missing information by asking specific questions, for example to your developers.
With the help of this information, we then formulate texts and create illustrations, e.g. B. for descriptions, instructions, application examples or notes. We make sure that the content is easy to understand and practical.
Check and correct
We edit and check the documentation according to the four-eyes principle before we forward it to you for proofreading. We carry out the review together with you. To ensure the best possible quality, we proofread the documentation again.
In agile software projects, the work steps of creating, checking and correcting are carried out iteratively in so-called sprints.
We would be happy to take over the translation management for you.
When creating the documentation, we make sure that the content is suitable for translation and that the terminology is clear and consistent.
We publish your technical documentation in the appropriate format, e.g. B. in Post-Script format for prepress, as compiled online help or dynamically in the content delivery portal.
If desired, we will archive and maintain your technical documentation.
Information structure and modularization
Clear criteria for structure and content are necessary in order to be able to create high quality information products. This is the only way to modularize the content and enrich it with metadata, for example to take product variants into account or to provide information dynamically in a portal or a mobile app.
Modularization enables reusability - redundancies are minimized. Information modules are intelligently managed in an editorial system (CCMS). So z. B. only those modules that have changed are forwarded to the translator.
We develop a corporate standard for you with which you can achieve a high degree of reuse and efficiently create and publish your information products.
In the information model, the required structure and information elements are described, classified according to their function and put in a logical order. We rely on common standards such as DocBook, DITA or PI-Mod.
On this basis, we develop a "tailor-made" information model for you in order to map your individual, product and industry-specific requirements.
Metadata describe the characteristics of an information module. Metadata simplifies and optimizes the search for and management of modules in the editorial system (CCMS). With the help of the metadata, individually tailored publications, e.g. B. for product variants or different usage situations can be created "at the push of a button". In addition, metadata can be used to bring together information from different systems - e. B. Product information from PDM, PIM or ERP.
Based on the classification and the planned publication concept, we develop the appropriate taxonomy, ontology and metadata structure. For the technical documentation, we model the metadata according to the iiRDS, VDI 2770 or other models.
We support you in developing existing data (legacy) and intelligent metadata recognition (tagging).
In a knowledge, service or content delivery portal, users can access specific information. There is no need to search for the information you want in a manual or PDF document. Semantic search and filter functions are used to display content that is required in the application context or for a specific task. For this purpose, the documentation must be divided into individual modules (topics) and linked using metadata.
We support you in setting up intelligent information systems. Together with you, we develop the semantic network that connects the modules with one another. We create and edit the content for your portal.
Economy and process optimization
Modularization enables reusability - redundancies are minimized. Information modules are intelligently managed in an editorial system. So z. B. only those modules that have changed since the last translation are forwarded to the translator.
Interchangeability and multiple use
The classification and modularization of information makes it possible to simply exchange content or use it in different contexts. With an intelligent variant control, information modules can be used repeatedly and in a targeted manner, e.g. B. for different product lines, sales regions or publication formats.
Individually tailored information
Information modules are classified according to product and variant and enriched with metadata. With the help of this metadata, individual documentation can be compiled and published without great effort. The user receives the information that is specific to his product - e. B. the product series, the variant or equipment - fits.
Information is precisely displayed in an information portal for technical documentation. Search results are narrowed down with facet filtering and context navigation. The user does not have to research the required information in a manual or a PDF document.
- Is green coffee good
- How well do realistic tattoos age
- What is the name of the Scottish Parliament
- What is the future of GPU computing
- How did Shakespeare Richard III. Shown
- Why is sieve analysis important
- Are flood damaged cars safe to drive?
- Social networking makes us social
- How long has the Han Chinese language been around?
- Don't grow nearbuy
- Georgia Tech has a grant service
- How do you feel about Australian society?
- What is special about Japan?
- The credit card needs a PIN when swiping
- Some urine bacteria are normal
- Italians are usually short
- Why is Taylor Swift a singer
- What does RR mean in motorcycles
- How is the Taiwanese education system
- How long can you go without sex
- Which IIT is best for research
- Punjabi is a dying language
- Which accessories should I buy
- What does an aging population need