Skip to content

Updated descriptions in the Abstract block #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dariavladykina wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated descriptions in the Abstract block #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions smart-doc/articles/assembly.asm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,36 +129,37 @@ The newest revision history comes first in the list -->
<dm:translation>yes</dm:translation>
</dm:docmanager>
<abstract>
<!-- Use the fixed abstract structure defined in the style guide to keep abstracts consistent across all articles-->
<variablelist>
<varlistentry>
<term>WHAT?</term>
<listitem>
<para>
Describe your topic in one sentence.
Provide an objective, one-sentence definition of the product, feature or solution.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WHY?</term>
<listitem>
<para>
State the reason why one should read this.
Explain why the reader should care and what problem or benefit this content addresses.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EFFORT</term>
<listitem>
<para>
What's the effort one has to put in?
State the expected time investment and any required background knowledge.
Copy link
Copy Markdown
Contributor

@taroth21 taroth21 Feb 23, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dariavladykina : In the past, some authors have given 'reading' time, others have given the time to understand the content and follow the instructions. Maybe we can clarify what kind of time investment (reading time vs. time to understand/execute'). IIRC, Frank and Jana J. had argued in the past that 'reading time per article' could be calculated automatically from the number of words (and this could be automatically displayed in the portal). Therefore, I would go for 'time to understand/execute' here because that one cannot be calculated automatically.

About 'required background knowledge': Wouldn't that rather belong to 'REQUIREMENTS'? I think

Copy link
Copy Markdown
Contributor Author

@dariavladykina dariavladykina Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree to move 'required background knowledge' to 'REQUIREMENTS', we'll discuss it in Stylewich.
The Effort piece is being discussed with the team.

</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
What's the reader's take-away from this article?
Describe the concrete outcome after the reader finishes this article.
</para>
</listitem>
</varlistentry>
Expand All @@ -168,7 +169,7 @@ The newest revision history comes first in the list -->
<itemizedlist>
<listitem>
<para>
List the requirements to accomplish the task(s) described below.
List prerequisites needed to complete the tasks described in this article.
</para>
</listitem>
</itemizedlist>
Expand Down