1. Creating your Company Knowledgebase
Your knowledgebase encapsulates all content for your documentation.
Create it in your new folder according to your industry segments or product category.
Choose the default language and add a preferred optional languages.
Your knowledgebase can include all your text, topics, pictures, videos, illustrations, 3D content and many more external sources for your created manual.
All additional items from whatever source can be shared and reused throughout your manuals.
We suggest keeping similar products (usually a product line) in a single knowledgebase, as these documents will likely share many of your topics.
Select now, Change later
Choose your default language, which will later be used for translations.
Don't forget that at any time you can always change your setup, add new languages, rename your knowledgebase and much more.
It's not the time to backup your empty knowledgebase yet, but it is always good to know that a complete knowledgebase can be backed up.
You can back it up to your local drive (from the manualogic cloud) and imported later anywhere within manualogic.
Alternatively it can always be imported or used at any time with any other software.
2. Writing Content in a Topic
It’s all about Content
Focus on content. Don’t worry about the design and layout at first, everything can be fixed later.
Your content is semantically organized, elements & topics are hierarchically structured for better editing & navigation.
You can easily add standard elements such as headers, paragraphs, images, videos, tables, links and lists.
Furthermore, you can add manual-specific elements such as notifications, warnings, safety messages, images with labels and/or headers, electric schematics, 3D object, icons and many more.
As your new digital manuals will be interactive, you can use many of our interactive, pre-built components, such as flowchart, steps, gallery, grid, pin image, pop-up Image, zoomable, map image, multi-image, FAQ or the menu.
Use Styles or Inline Styles
Concentrate on content and let automated styling take care of the rest. Use inline styling to stylize individual elements or even parts of the text only.
These global styles can be reused across the node (on all knowledgebases).
Adding Extra Content - Hyperlinks
Use as many hyperlinks as you like. Remember that interactive documents will keep all information related.
Once your reader finds the first piece of the puzzle, they will certainly appreciate the following pieces that are linked or on offer. You can even link content from external sources (using http links).
3. Adding Translations
Use our Automated Translation functionality tool
It has never been easier for your translations team to finalize language versions. All texts are automatically translated and styled, keeping in place the exact same graphics, annotations, layout and styles as in the original language version.
Language topic linking means every element is always linked to the master language. This way you can easily follow the translated topic and compare with the original content.
Then update and adjust all translations with your professional language team in your knowledgebase or individual topics.
Your images and special smart arts contain a lot of text information. You can now organize your images in languages as well as the other text elements.
Keep the master language image and all translations together, forever.
Keep Oversight of all Changes & Additions
Any changes in the original content are automatically tagged for translation, or can be automatically translated.
It is much easier for your branch managers, product managers or translation team to follow changes in the overall context, allowing them to focus on needed translations.
You can even translate the name of any documents, products, parameters or other supplementary data.
This leads to a much better publishing / user experience.
Use custom built Vocabulary Index
Custom vocabulary built on top of your node is a great tool to keep specific technical terms consistent.
Both automated translations or actual non-automated translations can benefit from this vocabulary index.
4. Organize your Topics into Document
Type of Documents
You can create eight types of documents: standard manual, producer page, product page, spare parts & accessories catalogue, maintenance log, service log and content marketing.
Reuse of Topics
Topics already created can be placed in many documents or even many times within a single document.
You never have to write this more than once, however, you can always decide to isolate individual topics (hardcopy) and keep it separated from it’s siblings.
Use Conditional Content
Conditional content is a great tool to keep your documents simple and organized.
If your future products have some parameters which determine the manual content, you can create topics or even elements that will only be visible to the owners of a particular product (with selected parameters).
Whilst there is still only one single physical copy of a complete document (which should cover all possible combinations), each user can still access their own bespoke copy.
Organize your topics in columns and separate topics in chapters, as you would do in a printed document. This is a continuous “book-like” flow of information.
However, thanks to your intensive use of links, a user can always navigate to related topics. The user will see the topic as a full-text scroll down screen adjustable to fit any screen.
If you decide to organize your topics within a Spider-web, your topics will be available from many sources (linked). Individual topics are organized around individual spiders and all spiders are organized together.
This way your reader will start at the selected place e.g. how to change a tyre on the car. Then related topics will follow on as they read further, such as where to buy a new tyre or get professional help.
Suggested topics are either automatically suggested by our AI algorithms or topics are suggested manually. Tables of contents are fully automatically created as well.
Indexes are always there for consideration and full-test search with predictive writing and built-in AI together create advanced navigation.
Each document can be limited for a specific country/continent or it can be valid for the whole world.
This way you might customize your information based on the user’s location and therefore easily follow local regulations.
5. Generate an online Book from your Document
The online Book is a snapshot of the current state of your document.
Using versioning & branching, a complete oversight of all previously published books is kept during the product lifespan.
Updates & Versions
With each topic and document you create you have visibility within your creative group. However, you certainly will need to publish the documents for your customers.
To do this, you can simply export the document, generate a book, choose a relevant title & subtitle, choose the language version to be exported and define the version. The version numbers are automatically suggested, but you can change them at any time.
You can use the generated static link anywhere you like, on your iframe, div or simply somewhere on your website to present the newly created content.
Each language version also has its own link and if you have used conditions, books include all options.
Using the ManualPal App
Now with complete control over your content it is the time to use all the features of your newly created document. Publish your document online (or bring it offline again) with just one click.
Newer versions will be automatically served to new customers, while existing versions will be preserved and offered an upgrade. Language versions will be completely included and conditional content delivered based on the selected product parameters.
Limited Reader Access Only
Your books can be password protected or limited to a specific audience.
This way you can provide documentation for the general public but also preserve other content for designated service technicians, sharing common topics whilst protecting exclusive content.
Add hashtags to your Books. This can be a very helpful addition for quick referencing.
6. Create Products and Link your Books
Now that you’re almost done
Your books are now online and users can access them readily, so it is time to create your Products.
We recommend creating products for better orientation and to add the use of conditional content.
Products are “entities” which correspond to your physical product. The product can serve many different documents created at manualogic or externally, which follow the actual lifecycle of your product, like delivering notifications at any time.
Later adding many exciting rich features within your products’ after-sales care.
Link External Content
Add any external resources such as links, PDFs, videos, etc. to your product.
While we believe that the content created by manualogic is fully customized for technical documentation, hovewer the use of already existing PDFs can still complement your manualogic content.
Make Products Accessible
Click “make product accessible” and it will be provided to all users of ManualPal instantly.
You can always update or even discontinue a product whilst always keeping complete control over your content.
Deliver Step-by-Step content
Books might be served sequentially to increase the impact and readability. Instead of providing a huge knowledgebase to your customer immediately, you can serve individual books in steps.
This allows the user to focus on the right content at the right time. This also works with notifications.
Organize your Products
Your “Product Family” includes all products with a shared set of parameters. The “Product Model” represents selected parameters and a “Product” represents the physical instance (e.g. WIN code or Serial/Number).
“Product Family” (Product line)
“Product Model” (parameter of the Product)
Add hashtags to your Books. This can be a very helpful addition for quick referencing.
Items are the integral parts of your product, either replacement parts, the square parts & accessories. These do not have individual manuals or marketing information.
We simply organize them under the “Product”. Once assigned to the product, spare parts and accessories catalogue is created automatically and maintained, fully tailored to the individual product, based on the individual parameters.