Skip to content

create diataxis documentation frame for ocm-website #841

@jakobmoellerdev

Description

@jakobmoellerdev

Description
Setup a diataxis based ocm documentation guideline.

This guideline is supposed to serve as framework to quickly answer which category of documentation (how to, tutorial, explanation, reference) (for which version of ocm) has to be written in which situation (such as a particular code change).

In other words, WHEN to write WHAT kind of documentation and WHERE to put it.

This is a spike as it includes research about diataxis.

Timebox: 1 day(s)

Done Criteria

  • Documentation guideline is available on the website
  • Estimation of impact on existing code incl. tests
  • Estimation of impact on Enduser Documentation updated (if applicable)
  • Estimation of impact on Internal technical Documentation created/updated (if applicable)
  • Created refinable tasks for the actual implementation

Metadata

Metadata

Labels

area/ipceiImportant Project of Common European Interest

Type

No fields configured for Spike.

Projects

Status
🔍 Review

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions