Tools for advanced users

Introduction

If you prefer, you may also choose to work with compatible tools on your local computer. Note that these are not required for project members in order to be able to participate at all! Instead, they usually provide advanced features for specific tasks. You may also be interested if you prefer working locally.

Tools list

The tools listed below are used in ASAM projects.

Click the icon to access the Project Guide’s tool info page.

Name	Description	Location
DevOps platforms	All source code and standard relevant documentation. Issues relevant to deliverables should be created here. This is relevant for everybody involved in ASAM projects!	Remote
Microsoft Sharepoint	Microsoft SharePoint is a web-based platform and collaboration tool developed by Microsoft. It serves as a document management and storage system. Used for any content not part of the deliverables of a standard, such as meeting minutes or presentations.	Remote
Git	The version control system ASAM uses. Relevant for users that want to check out the project repository to work locally.	Remote
Visual Studio Code	An all-in-one open-source text editor that makes life a lot easier. Relevant for users that want to edit AsciiDoc and other content files locally.	Local
Draw.io	An editor for diagrams. Can be downloaded or access through the browser. Also has a (limited) VS Code extension. Relevant for users that want to create new diagrams and images for their project.	Local / Web
Docker	(For local rendering of AsciiDoc) A tool for hosting containers. Relevant for users that want to run the build tools locally in order to create preview documents without the repository’s pipeline.	Local
PlantUML	A textual format to create UML and other diagrams. Relevant for users that want to create images or diagrams for ASAM standards.	Local

Name

Description

Usage

Location

DevOps platforms

All source code and standard relevant documentation. Issues relevant to deliverables should be created here.
This is relevant for everybody involved in ASAM projects!

Remote

Microsoft Sharepoint

Microsoft SharePoint is a web-based platform and collaboration tool developed by Microsoft. It serves as a document management and storage system.

Used for any content not part of the deliverables of a standard, such as meeting minutes or presentations.

Remote

Git

The version control system ASAM uses.
Relevant for users that want to check out the project repository to work locally.

Remote

Visual Studio Code

An all-in-one open-source text editor that makes life a lot easier.
Relevant for users that want to edit AsciiDoc and other content files locally.

Local

Draw.io

An editor for diagrams. Can be downloaded or access through the browser. Also has a (limited) VS Code extension.
Relevant for users that want to create new diagrams and images for their project.

Local / Web

Docker

(For local rendering of AsciiDoc)
A tool for hosting containers.
Relevant for users that want to run the build tools locally in order to create preview documents without the repository’s pipeline.

Local

PlantUML

A textual format to create UML and other diagrams.
Relevant for users that want to create images or diagrams for ASAM standards.

Local