About this documentation
🟥 Leadtime documentation offers a user-friendly interface with a search function and structured content in four text types for efficient information searches
This text is a reference. What types of text are there?
User interface of the documentation
The Leadtime documentation user interface has been designed to provide users with simple and intuitive navigation. It consists of seven main components, which are described in detail below.
1. search bar
The search bar is prominently located at the top of the page.
Here, users can search for specific keywords to quickly find relevant articles.
There is also the option of contacting the LeadtimeGPT chatbot directly to clarify any open questions about the application.
2. table of contents
A navigable table of contents is displayed on the left-hand side.
Structure:
- Sections: Displayed as main headings.
- Chapters: Subordinate categories that can be expanded by clicking on them.
- Articles: Directly selectable content within the chapters.
The table of contents enables quick navigation through the entire documentation.
3. article table of contents
As soon as an article is opened, a table of contents for the article appears in the right-hand column. This is based on the headings of the article. Users can click to jump directly to a specific section within the article.
4. article rating
At the end of each article, users can leave a rating:
- Positive (🙂): The article was helpful.
- Neutral (😐): The item was okay, but not perfect.
- Negative (😞): The information I was looking for was not available or unclear.
The ratings are analyzed in the backend in order to revise and improve texts in a targeted manner.
5. article navigation
Below the article there are buttons to quickly jump to the next or previous article.
This function facilitates continuous reading without having to return to the table of contents.
6. dark mode
Users can switch between a light and dark layout. This setting improves readability depending on personal preference and lighting conditions.
7. support button
If users cannot find a solution, a "Contact us" button is available. Clicking on this button opens a direct chat with a support employee to clarify individual questions.
Search function and LeadtimeGPT
The Leadtime documentation offers two ways to search for information efficiently: a classic term search and the use of LeadtimeGPT, an AI-supported chatbot.
Classic term search
Function: The classic search works like a search engine and is ideal for searching for specific terms or topics.
Operation:
- There is a search bar in the header area of the documentation.
- Alternatively, the search can be quickly activated with the key combination Cmd + K (or Ctrl + K on Windows).
- Enter a term, e.g. "ticket".
- After a short time, suitable article suggestions are displayed that contain the entered term or are thematically appropriate.
LeadtimeGPT
LeadtimeGPT is an AI-supported chatbot that has been trained on the content of the documentation. It makes it possible to ask open questions and receive answers based on the texts in the documentation.
How to use it:
- Enter a question in the search bar, e.g. "How do I create a ticket?".
- Click on the "Ask LeadtimeGPT" button, which appears as a suggestion.
- A chat window opens in the right sidebar.
- Ask your question or follow the bot's suggestions. The answer is displayed directly in the chat.
Advantages:
- Suitable for complex, open questions.
- Answers are contextual and often provide concrete step-by-step instructions.
- No need to navigate through articles yourself.
Structure of the documentation
Leadtime's documentation is clearly structured to enable intuitive navigation and efficient information searches. It is divided into ten main sections, each divided into chapters organized according to the four defined text types: Topic Overview, Background, Reference, and How-to. The chapters in turn contain specific articles, .
Each article deals with a specific topic within the chapter. The articles are designed to provide clear and concise information on a specific aspect of the chapter. They follow the structure and text type that is best suited to the particular context.
This hierarchical system ensures clarity and facilitates the use of the documentation.
Main areas of the documentation
Main area | Description |
Getting started with Leadtime | Introduction to the system, basic functions and onboarding process. |
Your workspace | Configuration of the personal work environment and customization of the installation. |
Employee management | Mapping and managing employees and teams in the system. |
Customer management | Management of organizations such as customers, partners and leads. |
Task management | Use of the ticket system for task structuring and prioritization. |
Time recording | Recording and evaluation of working time with time reports. |
Agile planning tools | Planning of work, resources and capacities using graphical tools. |
Project management | Management of projects and requirements. |
Quotations and invoices | Creation of quotations, invoices and reminders as well as support for receivables management. |
Evaluations | Graphical real-time evaluations and reports for analyzing performance and KPIs. |
Text types in the documentation
The documentation is divided into four different text types, each serving a specific purpose. Each text type is visually identified by a colored icon and a callout at the beginning of the text to quickly identify what type of information is provided.
Text type | Icon | Function |
Topic overview | 🟨 | Orientation and collection of links to thematically related articles. |
Background | 🟦 | Explanation of the motivation and context behind functions and solutions. |
Reference | 🟥 | Technical description and complete documentation of the software elements. |
Instructions | 🟩 | Practical step-by-step explanations for implementing specific tasks. |
🟨 Topic overview
Topic overviews are collections of links to thematically related articles within the documentation. They offer users a structured orientation aid and make it possible to find relevant information quickly.
Purpose: The purpose of the topic overview is to make it easier for users to get started in an area and to present complex topics clearly.
Examples of content:
- Lists of instructions that cover a specific feature.
- Links to context or reference articles that deal with related topics.
🟦 Background
Background texts explain the why question behind the features and functions of the software. They shed light on the problems that the software is intended to solve and convey the conceptual foundations.
Purpose: These texts create a deeper understanding of the software and its philosophy by presenting the benefits of the functions in a wider context.
Examples of content:
- Explanation of why a particular feature was developed.
- Scenarios in which the feature creates clear added value.
- Link between business challenges and the solution provided by the software.
🟥 Reference
Reference texts are detailed descriptions of all elements of the application. They explain what is available in the software and provide precise information on functions, fields and options.
Purpose: The reference provides users with a complete, technical documentation of the software. It serves as a reference work for the details of individual components of the application.
Examples of content:
- Description of all fields in a form and their purpose.
- Explanation of functions, buttons and menus.
- List of settings and their effects.
🟩 Instructions
Instructions provide step-by-step explanations of how certain actions can be carried out in the software. They are practice-oriented and show the exact procedure.
Purpose: These texts help users to carry out tasks efficiently and correctly. They are particularly helpful for new users or for the introduction of new features.
Examples of content:
- How to create a new project.
- Step-by-step instructions for exporting data.
- Instructions on how to configure user settings.