search

SUSE / doc-styleguide

SUSE Documentation Style Guide
https://susedoc.github.io/doc-styleguide/main/html/style-guide/
Other
14 stars 2 forks source link

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

Closed dariavladykina closed 2 months ago

dariavladykina commented 7 months ago

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.

dariavladykina commented 7 months ago

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

dariavladykina commented 2 months ago

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