OSM Documentation Workshop on Diataxis Framework: Difference between revisions

From OSM Public Wiki
Jump to: navigation, search
(Created blank page)
 
No edit summary
Line 1: Line 1:
<span style="font-size:180%;"> <div style='text-align: center;'> '''Monday 20th June and Wednesday 22nd June (12:00 - 14:00 UTC)'''</div></span>
[[File:OSM13_lead_image.jpg|800px|center|top]]     


= Overview=
OSM will host a documentation workshop carried by Daniele Procida (Canonical) about the  [https://diataxis.fr/ Diátaxis framework]. The framework breaks documentation down into 4 main categories:
* Tutorials (learning-oriented); practical, severs study
* How-to guides (task-oriented): practical, serves work
* Explanation (understanding-oriented): theoretical, severs study
* Reference (technical information): theoretical, serves work
The workshop will consist of two sessions of 2 hours, both theory and practice:
* Monday June 20th. Part 1 - Quality: introduction to the Diataxis framework: the diátaxis system and how it works
* Wednesday June 22nd. Part 2 - Execution: getting things done. Authoring practices and approaches.
The format will be a collaborative and interactive workshop, getting things done with minimum effort and maximum results.
= Registration =
Registration is free of charge and open to all, register '''[https://portal.etsi.org/Meetings.aspx#/meeting?MtgId=44129 here!]'''
You are most welcome to invite your colleagues and partners to join us.
= Join us =
* Join the [https://join.slack.com/t/opensourcemano/shared_invite/zt-4fkraa92-7VGPbFtOQn6pJSWzVV8Bxw OSM Community Slack Workspace]
* If your organization is already an [https://portal.etsi.org/TBSiteMap/OSM/ListofOSMMembers.aspx OSM member], you can also:
** [https://webapp.etsi.org/createaccount/ Request an EOL account] (if you don’t have one yet)
** Subscribe [https://list.etsi.org/scripts/wa.exe?SUBED1=OSG_OSM&A=1 OSG OSM] and [https://list.etsi.org/scripts/wa.exe?SUBED1=OSM_TECH&A=1 OSM TECH] mailing lists
* If your organization is not yet an OSM member:
** Learn [https://osm.etsi.org/about/how-to-join how to join], it is free and open to all
* Join the [https://osm.etsi.org/wikipub/index.php/OSM_Ecosystem OSM Ecosystem]
= Contact =
Please send your technical questions to [mailto:OSM_TECH@list.etsi.org OSM_TECH@list.etsi.org],  [https://join.slack.com/t/opensourcemano/shared_invite/zt-4fkraa92-7VGPbFtOQn6pJSWzVV8Bxw OSM Community Slack Workspace] or [https://charmed-osm.com/#get-in-touch Contact us] directly
Questions about ETSI, joining OSM, this and future events can be sent to [mailto:OSMsupport@etsi.org OSMSupport@etsi.org]

Revision as of 09:04, 17 May 2022

Monday 20th June and Wednesday 22nd June (12:00 - 14:00 UTC)
OSM13 lead image.jpg

Overview

OSM will host a documentation workshop carried by Daniele Procida (Canonical) about the Diátaxis framework. The framework breaks documentation down into 4 main categories:

  • Tutorials (learning-oriented); practical, severs study
  • How-to guides (task-oriented): practical, serves work
  • Explanation (understanding-oriented): theoretical, severs study
  • Reference (technical information): theoretical, serves work

The workshop will consist of two sessions of 2 hours, both theory and practice:

  • Monday June 20th. Part 1 - Quality: introduction to the Diataxis framework: the diátaxis system and how it works
  • Wednesday June 22nd. Part 2 - Execution: getting things done. Authoring practices and approaches.

The format will be a collaborative and interactive workshop, getting things done with minimum effort and maximum results.

Registration

Registration is free of charge and open to all, register here! You are most welcome to invite your colleagues and partners to join us.

Join us

Contact

Please send your technical questions to OSM_TECH@list.etsi.org, OSM Community Slack Workspace or Contact us directly

Questions about ETSI, joining OSM, this and future events can be sent to OSMSupport@etsi.org

Retrieved from "http:///wikipub/index.php?title=OSM_Documentation_Workshop_on_Diataxis_Framework&oldid=6683"