SUSE/doc-styleguide

Suggest a structure for WHAT? WHY? EFFORT etc. items in Smart Docs

dariavladykina opened this issue · 2 comments

Very often at the beginning of an article in Smart Docs, we can see something like:

WHY?
You want to examine what was happening on your system by viewing system logs.

It seems there could be better wording like e.g.: This article provides instructions on how to examine what happened on your system by viewing system logs.

Suggest to reword it even better: To examine what happened on your system by viewing system logs.

This has been attended to in Smart Doc templates and guidelines, so closing it here.