One of our contributors writing a concept topic (#2513532: Write user-admin-account.txt) brought up a question about the template.

Right now its heading structure is:

=== What is a ...?
==== Prerequisite knowledge
==== Concept: What is a ....?
==== Related topics
==== Additional resources

The contributor didn't particularly like the "Concept: What is a ...?" header.

Should we:

a) Keep it as it is

b) Think of some other heading to indicate "This is the actual concept information"

Comments

Les Lim’s picture

Les Lim
he/they
Primary language English
CreditAttribution: Les Lim commented

I had a similar reaction writing block-concept.txt. With no "Prerequisite knowledge" content, that section was commented out and the outline went like this:

=== What is a block?
==== Concept: What is a block?
==== Related topics
==== Additional resources

That seems oddly redundant. Perhaps it would help if "Concept:" were at the top level, and the "What is ...?" question were a subsection:

=== Concept: Blocks
==== Prerequisite knowledge
==== What is a block?
==== Related topics
==== Additional resources

This seems like a minor issue, though. Even if the headers are redundant, I don't believe they are confusing or unclear.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon as a volunteer commented

Oh, I like the suggestion in #1 of making the topic title be something like "Concept: Blocks" and within that, have the header be "What is a ....?".

Any thoughts @eojthebrave or @ifrik (or anyone else)?

eojthebrave’s picture

eojthebrave
he/him
Primary language English
Location Minneapolis, MN
CreditAttribution: eojthebrave as a volunteer commented

+1, makes sense to me.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon as a volunteer commented
Status: Active » Fixed

OK then. I'll go ahead and make that change, and update the several existing topics we have as well.

Thanks again Les for the suggestion!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.