search

redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
80 stars 67 forks source link

[WIP] Checklist #211

Closed rolfedh closed 5 months ago

rolfedh commented 10 months ago

Closes https://github.com/redhat-documentation/modular-docs/issues/206 This is an early draft. No need to review or comment at this stage.

mjahoda commented 10 months ago

Thank you for creating a comprehensive draft of the check list in such a short time. I am just thinking of creating another check list, much briefer, containing only the "rules" that are most commonly problematic. We could include both check lists (the brief one, your "full"). If you and also other members agree, I'd try to propose the items for a short check list. If this'll sound like a non-sense to others, I'll focus only on reviewing your draft.

Just one nitpick immediatelly: we probably use sentence case in the rest of the guide.

Edit: I'm taking back the "check list" term. IBM Style mandates "checklist" as you write. I'm sorry for the noise.

rolfedh commented 9 months ago

I am just thinking of creating another check list,

Hi @mjahoda - let's move this conversation to the issue, https://github.com/redhat-documentation/modular-docs/issues/206.