Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

Page name: Functional job (1)

  1. Start with a verb or how-to + verb(representing the main goal of the article)

  2. Focus on outcome of a process

  3. Indicate context/granularity

  4. Represent user’s perspective

Example: Introduce yourself to algorithm training with IKOSA AI / How-to manage wrong predictions?

Delete this block before publishing!

Info

One-liner: Desired outcome

  1. Start with a direction (minimize, reduce, lower, maximize, increase, raise)

  2. Specify the unit (time, ability, effort, chances, likelihood)

  3. Add qualifier without using “and“ or “or“

Example: Increase the ease of algorithm training.

Delete this block before publishing!

...

Short description: Situation and motivation

  1. Start by defining the context (situation) and the desired outcome (motivation) in one simple and short sentence.

  2. Explain how it can be achieved by means of prepared content in one simple and short sentence

Example: You need to have a well-performing algorithm quickly to progress your research - we get that. To help you achieve that we prepared a step-by-step guide to go smoothly through the training steps.

...

Configure your system to import CSV files into Microsoft Excel without friction.

You want to run some statistics and plots on data from image analysis applications? A correct import of CSV (comma-separated values) into Microsoft Excel depends on your system configuration, namely, which regional format settings system are currently configured in your Windows operating system.

Info

Table of contents: Functional job (2)

  1. Fixed H1: What to expect from this page?

  2. Table of contents

Delete this block before publishing!

What to expect from this page?

Table of Contents
minLevel1
maxLevel3
excludeWhat to expect from this page?

📑

...

Region settings in Windows

Info

Content types:

  • short text;

  • visualizations (images, figures, renderings, graphics, schemes, software screenshots);

  • short videos (5-10 minutes)/animations/video snippets;

  • links to articles/case studies/white papers published on our website and

  • references to scientific publications

Content requirements:

  • Easily digestible information

  • As specific as possible

  • Chunked information

  • Condensed

  • No hard core details

  • Soft language

Delete this block before publishing!

Start writing here…If your MS Windows region settings are not set to an English locale, you need to take care of setting the correct decimal and thousands delimiters during the CSV import into Excel.

Info

Please note: notification text here…

...

Panel
panelIconId1f4cd
panelIcon:round_pushpin:
panelIconText📍
bgColor#EAE6FF

Extra information to highlight a feature/function/anything what deserves special attention…

Subsection

Start writing here…

📑 Section

Start writing here…

Subsection

Start writing here…

Info

Conclusion: Emotional job

  1. At the end of the article, cheer the reader up and highlight the success of their possible emotional job.

  2. If the user's action is not complete at this point and reading another instruction is implied for successful completion of the task, offer it as additional help.

Example: You are done with the training!

Now it’s time to evaluate how did it go. If you need any help with that, we have for you a couple of how-to articles.

Delete this block before publishing!

Info

Conclusion: Social job

Propose a social action if relevant.

Example: Share the progress of your training with colleagues, discuss the outcomes and make new discoveries!

Delete this block before publishing!

...

If you have any questions, please send us an email at support@ikosa.ai.

...

📚 Related articles

Info

Adjust displayed content of related articles by the label of the main section the published article belongs to.

Delete this block before publishing!

Filter by label (Content by label)
max5
sorttitle
showSpacefalse
cqllabel = "kb-how-to-article" and space = "KB"
Info

Don't forget to add labels to this article to increase its searchability. Add labels of the main section where it belongs to and subject related labels.

Labelling technique:

  • start label name with a noun (ex. annotation, image, etc)

  • use dash “-“ between the words

  • don’t use more than 3 words in one label

Example: algorithm-prediction-analysis

Delete this block before publishing!