Text style guide

Note: Here is the Design Style Guide.

Naming Conventions

Testup : Name of the project.

Thetaris GmbH: Name of the company.

Editor

Anchor Area -> Draw an Anchor Area

Project -> Project Page

Test -> Test Detail Page

Recording

Recording Viewer

System under Test

Schedule an Action

Schedule an Input

Play an action

Input bar

Action list -> list of checks and inputs (right side of the editor)

Structure

The structure of the documentation is:

<h2>for title</h2>

<h3>for heading of a paragraph</h3>

<p>for the paragraph with possible <strong><strong>bold font</strong></strong> for highlithting one or two words.</p>

 

The structure of the documentation is:

<h2>for title</h2>

<h3>for heading of a paragraph</h3>

<p>for the text</p>

The image is defined as featured image.

Categories

Blog entry:
must have the category “blog”.

Article for the documentation:
must have the category “documentation” and at least one of the sub-categories of “documentation”.

Tags

Choose 3 to 4 existing tags for  blog posts.

If needed create a new tag.

Writing

Capital Letters:

In the title use Capital Letters at the Beginning of All Words Except for Articles, Prepositions and Secondary Conjunctions (i.e. the, for, to, by…)

In the Text use capital letter for the first word of the sentence and geographical names, cities, countries, regions, languages, nationalities, names of months, weekdays and holidays.

Tone

Blog:
The tone of the blog can vary from article to article.

In many cases a personal story draws more readers.

Documentation:
The tone of the text should be objective.

Do not write “you” or “I”.

Use simple verb forms (Avoid: Information has been received – Use: Information received)

Avoid long detailed Information

Don’t write numbers as words

Avoid capitalizing all letters

Avoid totality and over-promising (avoid: We’ll never give you irrelevant information – use: You’ll receive only crucial information)

Don’t blame users (avoid: You’ve entered a wrong password – use: The password cannot be used. Please ensure its 8 characters long.)

Avoid using lots of words. Be simple and direct for users to understand you. Leave out extra words that do not add value.

Buttons

Keys

press [Enter]

Icon and Text

How to use
Write the following text-snippet between two brackets: [text-snippet]

1-line-buttons: 

[tu-btn-one-line name=”tu-edit“]

2-line-buttons: 

[tu-btn-two-line name=”tu-enter-text“]
Defined Buttons

tu-animate-comparision

Comparison Animation toggles between the benchmark screen and the screen in the current test.

tu-back

Add Step: Navigate to previous webpage

tu-back-space

Add step: Press the backspace key

tu-check

Edit next step: Transform the next step to a check 

tu-click

Edit next step: Transform the next step to a left-click

tu-compare-recording

Choose the recording you want to compare the current recording with

tu-comparing-with

Click to see the screen of the comparative testrun

tu-complain

Click here if you think there is a bug.

tu-copy

Add step: Copy the currently selected values to the clipboard

tu-create-project

Create a new project

tu-create-schedule

Create a new schedule in the current project

tu-create-test

Create a new test in the current project

tu-currently-viewing

Click to see the screen of the current testrun

tu-cut

Add step: Cut the currently selected values and copy them to the clipboard

tu-delete

tu-delete

tu-delete-project

tu-delete-test

tu-disable

Disables the step. If a step is disabled, it will be skipped when you execute the test.

tu-disabled

This step is disabled and will be skipped when you execute the test.

tu-done

tu-double-click

Edit the current step to be a double click instead.

tu-down

Add step: Click the down arrow on the keybord

tu-duplicate-project

tu-edit

tu-enabled

tu-end

tu-end-failed

tu-end-success

tu-enter

tu-equals

Compare the entered text with the current clipboard value. The result will be stored in the clipboard. The check is NOT case sensitive

tu-enter-text

Add step: Enter text.

tu-eval

tu-find

Add step: Check if the selection is visible on the screen. If the check fails, the test is stopped with an error

tu-forward

tu-frame-next

tu-frame-prev

tu-go-editor

tu-help

tu-home

tu-invite

tu-issue-next

tu-issue-prev

tu-jump

tu-jump-false

tu-jump-here

tu-jump-true

tu-left

tu-load

tu-make-iframe

tu-more

tu-next-tab

tu-open-url

tu-page-dn

tu-page-up

tu-password

tu-paste

tu-play

tu-play-one

tu-play-all

tu-play-it

tu-refresh

tu-regenerate

tu-reload

tu-replay

tu-reset

tu-retake

tu-right

tu-right-click

tu-select-all

tu-set-base

tu-show-actions

tu-space

tu-start-editing

tu-stop

tu-stop-all

tu-swipe-down

tu-swipe-right

tu-tab

tu-tag

tu-three-dots

tu-timeout

tu-up

tu-wait

Cards

How to use

Write the following text-snippet between two brackets: [text-snippet]

Different Cards

[tu-card-green name=”tu-project“]

Defined Cards

tu-project

Coloured Buttons

How to use

Write the following text-snippet between two brackets: [text-snippet]

Different Buttons

[tu-btn-orange name=”tu-free“]

[tu-btn-green name=”tu-playing-next“]

[tu-btn-grey name=”tu-play-here“]

[tu-btn-red name=”tu-not-found“]

Defined Buttons

tu-free

tu-professional

tu-app

tu-playing

tu-progress

tu-current

tu-playing-next

tu-jump-here

tu-play-here

tu-not-found

Help Buttons

How to use

Write the following text-snippet between two brackets: [text-snippet]

Different Buttons

[tu-btn-help name=”tu-play“]  -> with X

[tu-btn-use name=”tu-use“]   -> without x

Defined Buttons

tu-check

tu-key  

tu-use 

Ribbons

How to use

Write the following text-snippet between two brackets: [text-snippet]

Different Ribbons

[tu-rib-green name=”tu-passed“]

[tu-rib-grey name=”tu-playing“]

[tu-rib-orange name=”tu-playing“]

[tu-rib-red name=”tu-failed“]

Defined Ribbons

tu-passed

tu-playing

tu-playing

tu-failed

Modes

How to use

Write the following text-snippet between two brackets: [text-snippet]

Different Modes

[tu-mode name=”tu-play“]

Defined Buttons

tu-compare

tu-control

tu-edit

tu-executions

tu-insert

tu-play

tu-project-settings

tu-recordings

tu-test-settings

tu-view

Well done so far!

Was something unclear?

We have our own Slack workspace for your support, which you are welcome to join.