Documentation

Comprehensive guide to using assessmentbird.io – from registration to PDF reports.

Getting Started

Registration & Login

Open the homepage and click "Get Started Free". Fill in the registration form with your name, email address, an organization name, and a secure password. After registration, you'll receive a confirmation email – click the link inside to verify your email address.

Alternatively, you can sign up via "Sign in with GitHub". Your GitHub account will be automatically linked, allowing you to log in with one click in the future.

The Dashboard

After logging in, you'll land on the dashboard. Here you can see at a glance:

  • Four metric cards: Number of customers, total assessments, completed assessments, and assessments in progress.
  • Quick start cards: Direct links to create a new assessment, browse the Template Catalog, and add a new customer.
  • Recent assessments: A table of your five most recent assessments with status and direct access.

Customer Management

Overview

Click "Customers" in the main navigation. You'll see a table of all customers with company name, contact person, email, city, and creator. Use the search field to filter the list.

Create a New Customer

Click "New Customer". Fill in at least the company name (required field). Optionally you can add:

  • Contact person, email, and phone number
  • Address (street, ZIP, city, country)
  • A company logo (uploaded via file upload)
  • Free-text notes

Click "Create" to save the customer.

Edit & Delete Customers

In the customer table, each entry has action buttons for editing (pencil icon) and deleting (trash icon). Deletion requires confirmation.

Warning: Deleting a customer is irreversible.

Customer Details

Click on a customer to view their details and all associated assessments. From here, you can directly start a new assessment for this customer.

Question Catalogs

What is a Catalog?

A catalog is a structured collection of questions, divided into categories. Each question has descriptions for the five maturity levels (1–5), optional weighting, and optional automatic recommendations. Catalogs go through three statuses:

DraftPublishedArchived

Use a Catalog from the Template Catalog

The fastest way to your first assessment: Click "Template Catalog" in the navigation. There you'll find free catalog templates. Select a template, configure customer and title, and start an assessment directly. All catalog templates are free.

Create Your Own Catalog (Admins Only)

Click "Catalogs" → "New Catalog". Enter a name, an optional description, and a version number (e.g., "1.0"). The catalog is created as a draft.

Each organization receives 1 free catalog credit. For additional custom catalogs, you can purchase more credits (see "Catalog Credits").

Add Categories

Open the catalog and click "New Category". Enter a name, an optional description, and a weight. The weight determines how strongly this category factors into the overall score. You can reorder categories via drag-and-drop.

Add Questions

Select a category and click "Add Question". Fill in the question text and describe what each of the five levels means for this question:

  • Level 1 – Not Present: The assessed area is non-existent or minimal.
  • Level 2 – Initial: First approaches exist but are not standardized.
  • Level 3 – Repeatable: Documented, repeatable processes exist.
  • Level 4 – Defined: Standardized and measured processes are established.
  • Level 5 – Optimized: Continuous improvement and optimized processes.

Optionally, you can set a weight for the question.

Define Recommendations

For each question, you can create recommendations with a threshold. Click "Manage Recommendations" then "Add Recommendation". Enter the recommendation text and select a threshold (e.g., "From level 3"). If the score during the assessment falls below this threshold, the recommendation is automatically displayed – both in the assessment and in the PDF report.

Publish a Catalog

When your catalog is ready, click "Publish". Only published catalogs can be used for assessments. After publishing, the catalog cannot be edited – create a new version if needed.

Versioning

To modify a published catalog, click "New Version". A copy is created as a draft. Existing assessments remain linked to the previous version. In the versions panel ("Versions" button), you can view all versions of a catalog.

Assessments

Create an Assessment

Click "Assessments" → "New Assessment". Select a customer and a published catalog. Optionally, you can provide a title (e.g., "Annual Assessment 2026") and the auditor's name. Click "Start Assessment".

Conduct an Assessment

After starting, the assessment view opens. On the left, you see categories and questions as navigation. In the center, the current question is displayed with five rating levels. Click on a level (1–5) to rate the question.

Special features during assessment:

  • Auto-Save: Every rating is saved immediately. You'll see a "Saved" indicator in the top right.
  • Auto-Advance: Enable "Auto-Advance" to automatically jump to the next question after each rating.
  • Keyboard Control: Keys 1–5 for rating, U to clear, arrow keys or W/Z for navigation, N for notes, E for custom recommendation, A for auto-advance toggle.
  • Notes: Add individual notes for each question in the notes field.
  • Custom Recommendation: Besides automatic recommendations, you can enter a custom recommendation per question.
  • Automatic Recommendations: When the score falls below the defined threshold, catalog recommendations are automatically displayed.
  • Progress Indicator: At the top, you can see how many questions have been answered.

Complete an Assessment

When all questions are answered (or you want to finish early), click "Complete". You'll be asked for confirmation. After completion, no further changes can be made.

View Results

After completion, the results page opens. There you'll see:

  • Overall Score: A weighted score from 1.0 to 5.0 with color coding.
  • Spider Chart: Visualization of all category scores.
  • Bar Chart: Category ratings in direct comparison.
  • Detail View: All questions with scores, notes, and recommendations per category.

Generate PDF Reports

On the results page, you'll find two download buttons:

  • PDF Executive Summary: Compact report for decision-makers with overall score, category overview, and top weaknesses.
  • PDF Detailed: Complete report with all questions, scores, notes, and recommendations.

Both PDFs use your organization's logo, color scheme, and the disclaimer/confidentiality notices configured in settings.

Reassess

Via the "Reassess" button on the results page, you create a copy of the assessment with the same customer and catalog. This is useful for annual comparison assessments.

Archive & Restore

Completed assessments can be moved to the archive via "Archive" and restored via "Restore" when needed.

Filter & Overview

On the assessments page, you can filter by status: All, Draft, In Progress, Completed, Archived. The tabs show the number of assessments in each status.

Template Catalog

Public Access

The Template Catalog is accessible without logging in. You can browse all available templates, view details, and get an overview before registering. A login is required to use a template.

Browse Templates

Use the search field for full-text search by name and description. Use tag filters (e.g., AWS, Kubernetes, Security, DevOps) to narrow results by topic. Additionally, you can filter by language (German, English, or All).

Each template shows name, description, author, version, number of categories and questions, tags, available languages, and a category preview with sample questions.

Create Assessment from Template

To create an assessment directly from a catalog template:

  1. Select template: Find the desired template in the Template Catalog and open the detail page.
  2. Configure assessment: Select a customer, set an assessment title, and optionally provide an auditor name.
  3. Start assessment: A catalog snapshot is automatically created and the assessment starts.

Catalog Credits

Catalog templates are free. For custom catalogs, you need catalog credits. Each organization receives 1 credit for free. Additional credits can be purchased in packages:

  • 1 Credit
  • 5 Credits (reduced per-credit price)
  • 10 Credits (best per-credit price)

Payment is processed securely via Stripe Checkout. Tax (19% VAT) is automatically calculated and displayed. After successful payment, credits are immediately added to your organization.

You can view your current credit balance on the Catalogs page as well as on the Catalog Credits page.

Settings (Admins Only)

Organization

Under "Settings" → "Organization" you can customize:

  • Organization name
  • Logo: Displayed in the navigation and on PDF reports.
  • Address: Street, ZIP, city, website, and email.
  • Color theme: Choose between Dark, Light, Blue, Green, or Violet. The color scheme is also used on PDF reports.

PDF Reports

Under "Settings" → "PDF Reports" you can configure the appearance of your PDF reports:

  • Company Name: Appears as the sender on reports.
  • Company Logo: A separate logo for PDF cover pages (can differ from the organization logo).
  • Report Title: The main title on the cover page and footer (e.g., "IT Maturity Analysis", "Security Audit Report").
  • Disclaimer: Custom disclaimer text, configurable separately for German and English (max. 1,000 characters per language).
  • Confidentiality Notice: Custom confidentiality notice, also configurable separately for German and English (max. 1,000 characters per language).

If no custom disclaimer or confidentiality notice is set, a default text is used. The displayed text follows the language preference of the user exporting the report.

Manage Members

Under "Settings" → "Members" you can see all team members and pending invitations.

Invite a new member:

  1. Enter the email address of the new member.
  2. Select a role: Admin or Member.
  3. Click "Send Invitation".

The invited person receives an email with an invitation link (valid for 7 days). You can change roles and remove members.

Users

Under "Settings" → "Users" you'll see all users grouped by role (Owner, Admins, Users). Here you can create new users, edit existing ones, and activate/deactivate users. Deactivated users cannot log in.

Activity Log

Under "Settings" → "Activity Log" you'll see a chronological log of all actions in your organization: who created, changed, deleted, or published what, and when. Filter by object type (Assessments, Catalogs, Customers, Users, Organization).

Profile

Profile Photo

Upload a profile photo and choose a crop area. The photo is displayed in the navigation and in your team entries. To remove the photo, click the remove button.

Profile Information

Change your name and email address. When changing your email, you'll need to verify it again.

Password

Change your password. Enter your current password and your new password (with confirmation). Use a long, random password for maximum security.

Language

Choose your preferred language for the user interface: German or English. The change takes effect immediately.

GitHub Account

Link or unlink your GitHub account. With a linked account, you can log in via "Sign in with GitHub" without entering your password each time.

Delete Account

Permanently delete your account. All associated data will be permanently removed. You must enter your password to confirm the deletion.

Warning: This action cannot be undone. Back up all important data before proceeding.

Roles & Permissions

FeatureOwnerAdminMember
View dashboard
Create/edit/delete customers
Create/conduct assessments
Download PDF reports
Create/edit/publish catalogs
Claim catalog templates
Change settings
Manage users
Invite/remove members
View activity log

Notes

  • There is exactly one owner per organization. The owner cannot be removed.
  • Admins have the same rights as the owner but can be removed by the owner.
  • Members can conduct assessments and manage customers but have no access to catalog editing, settings, or user management.

Scoring System

The Five Maturity Levels

1
Not Present: The assessed area is non-existent or minimal.
2
Initial: First approaches exist but are not standardized.
3
Repeatable: Documented, repeatable processes exist.
4
Defined: Standardized and measured processes are established.
5
Optimized: Continuous improvement and optimized processes.

Weighting

Both questions and categories can be weighted. The calculation works in two stages:

  1. Category Score: Weighted average of all question scores within the category.
  2. Overall Score: Weighted average of all category scores.

Example: If one question has weight 2 and another has weight 1, the first question counts twice as much toward the category score.

Keyboard Shortcuts

The following keyboard shortcuts are available during assessment conduct:

KeyFunction
15Set rating to the respective level
UClear rating
/ WNext question
/ ZPrevious question
NFocus notes field
EFocus custom recommendation
AToggle auto-advance on/off