Available documentation

This article discusses the available documentation on Codebots including docs in our Library and docs provided as part of the Target application.


Codebots provides a large variety of documentation ranging from reference documents, through to learning guides, and courses.

The documentation provided by Codebots comes in many formats and each is designed for a specific purpose. There are two primary locations where this documentation can be found are:

  1. Codebots - The Codebots Platform
  2. Target application - Your application running in your environment

The documentation covered both system and product scopes.

Codebots.

Much of the documentation is available from the https://codebots.app.

Diagrams.

For this example we will be using Learning Management System (LMS) - Example project

The diagrams that are developed on Codebots act as an abstract representation of the software application. They provide a mechanism for understanding the system in addition to their ability to update it. They describe the system not the product, and as such, are incredibly valuable for the integration, planning, and development stages of a project.

Entity diagram

The Entity diagram represents the data architecture, similar in form to a class diagram or a database schema diagram. It presents each business object, constraints, relationships, as well as additional meta data associated with each of these as they are found within the application.

Additional information that is documented in this diagram includes, user groups (User Extension Overview) and runtime configurable plugins (Forms extension overview, Workflow extension overview, and Timelines extension overview extensions).

More details on what an extension is can be found in What is an extension?.

LMS Sharp entity diagram

For more details on what the Entity diagram is please see .

Interface diagram.

The Interface diagram represents the pages, and their contents, within your application. Additional meta data is also documented here with details around which is home page, descriptions, and titles.

UI diagram LMS Sharp
Security diagram.

The Security diagram represents the user groups and their level of access to each business object and page within your application. This is an important document within the authorisation and auditing part of the applications AAA security rules.

LMS Sharp security diagram

For details on how to use the Security diagram please see Using the Security diagram.

Library

The Library is the knowledge base containing all the information for Codebots and your applications. The Library is organised into “books” with each book containing a variety of articles covering; release notes, best practice guidelines, learning guides, reference documents, and much more. Codebots provides a collection of articles and books that can be browsed or searched, as well as the ability to create your own articles and books in order to document your application as part of growing your own knowledge base.

Library landing page

For more information on using the Library see What is the Library?.

Academy

The Codebots Academy is where you can learn all you need to know about Codebots, and become qualified in everything from building applications on the Platform to working with our extensions.

Academy landing page

For more details see Using Academy.

Target application

Once you have built your application and How do I run my app? a new set of documentation will become available. This documentation is more technical in nature and is invaluable for development as it provides insight into the implementation of the application, not just the high level architecture that is provided by the diagrams or the product that is provided by Test and Plan.

Each codebot writes documentation for the APIs as well as the codebase. Pleas see the following two articles for details:


Ready to start building?

Sign up to Codebots today to see how much faster you can build apps with us.