Page values for "Submissions:2023/Save the time of the reader: improve your technical documentation through minimalist design"
"2023_submissions" values
2 rows are stored for this pageField | Field type | Value |
---|---|---|
title | String | Save the time of the reader: improve your technical documentation through minimalist design |
status | String | Declined |
theme | String | Technology |
type | String | Workshop |
abstract | Wikitext | Ranganathan's fourth law of library science, "Save the time of the reader," describes how guides and frameworks that benefit library users also benefit librarians and other maintainers of information systems?'"`UNIQ--ref-00000004-QINU`"'?. The laws of library science apply to technical documentation! In this workshop, participants will learn how to apply minimalist information design principles?'"`UNIQ--ref-00000005-QINU`"'? to save the time of readers, while also making it easier to maintain documentation in our shared technical ecosystem. Proposed workshop structure:
After the brief introduction and instruction sections, participants will choose a technical document to improve. Then, we'll work synchronously and share ideas as we explore how minimalism can help us be strategic about revising docs to improve their usability and readability. Specifically, our revisions will focus on how to save the time of our readers (and future editors) by:
While the focus of this workshop will be on technical documentation, the principles are widely applicable to many types of written communication. Participants are welcome to edit any wikis or documents, but the content used for instruction and the suggested pages to edit will all be from Wikimedia technical wikis. |
author | String | Tricia Burmeister |
List of Email, delimiter: , | tburmeister@wikimedia.org | |
username | String | TBurmeister_(WMF) |
affiliates | String | Wikimedia Foundation |
time | String | 75 |
requests | Wikitext | |
presented | Wikitext | I presented about writing & maintaining technical documentation as a community at the 2022 Wikimedia Hackathon [?'"`UNIQ--nowiki-00000007-QINU`"'?slides]. In my professional capacity as a technical writer, I've presented on information design and task-oriented documentation in various forums and settings, usually to technical audiences at engineering team events or developer summits. |
livestream | Boolean | Yes |
video | String |
Field | Field type | Value |
---|---|---|
title | String | Save the time of the reader: improve your technical documentation through minimalist design |
status | String | Declined |
theme | String | Technology |
type | String | Workshop |
abstract | Wikitext | Ranganathan's fourth law of library science, "Save the time of the reader," describes how guides and frameworks that benefit library users also benefit librarians and other maintainers of information systems?'"`UNIQ--ref-00000008-QINU`"'?. The laws of library science apply to technical documentation! In this workshop, participants will learn how to apply minimalist information design principles?'"`UNIQ--ref-00000009-QINU`"'? to save the time of readers, while also making it easier to maintain documentation in our shared technical ecosystem. Proposed workshop structure:
After the brief introduction and instruction sections, participants will choose a technical document to improve. Then, we'll work synchronously and share ideas as we explore how minimalism can help us be strategic about revising docs to improve their usability and readability. Specifically, our revisions will focus on how to save the time of our readers (and future editors) by:
While the focus of this workshop will be on technical documentation, the principles are widely applicable to many types of written communication. Participants are welcome to edit any wikis or documents, but the content used for instruction and the suggested pages to edit will all be from Wikimedia technical wikis. |
author | String | Tricia Burmeister |
List of Email, delimiter: , | tburmeister@wikimedia.org | |
username | String | TBurmeister_(WMF) |
affiliates | String | Wikimedia Foundation |
time | String | 75 |
requests | Wikitext | |
presented | Wikitext | I presented about writing & maintaining technical documentation as a community at the 2022 Wikimedia Hackathon [?'"`UNIQ--nowiki-0000000B-QINU`"'?slides]. In my professional capacity as a technical writer, I've presented on information design and task-oriented documentation in various forums and settings, usually to technical audiences at engineering team events or developer summits. |
livestream | Boolean | Yes |
video | String |