OSE Manual Template: Difference between revisions
Jump to navigation
Jump to search
(→Master) |
No edit summary |
||
| Line 1: | Line 1: | ||
=Manual Production= | =Manual Production= | ||
In general OSE's open source product development relies on roles being selected via [[Meritocratic Do-ocracy]]. | |||
We suggest creating manuals as a 3 step process. | We suggest creating manuals as a 3 step process. | ||
#Write the main script with content and outline, using a basic template that contains OSE style and branding | #Write the main script with content and outline, using a basic template that contains OSE style and branding | ||
##Use [[OSE Manual Template]] cover page to describe the manual and provide a QR Code for online access for people who are using printed or online copies of the manual. | ##Use [[OSE Manual Template]] for the cover page to describe the manual and provide a QR Code for online access for people who are using printed or online copies of the manual. | ||
##Use a | ##Use a Manual Index Template found in the template below for the Index | ||
##Use basis formatting ONLY in the following pages, using | ##Use basis formatting ONLY in the following pages, using the Manual Content Template below. This is because subsequent editing will produce the final formatted copy, and time would be wasted if format editing is applied prior to most of the content being created. | ||
##The lead editor | ##The lead editor sets up the Cover Page and Index. | ||
##Large numbers (100s to 1000s) of contributing editors can edit a single document once the main outline has been created. | ##Large numbers (100s to 1000s) of contributing editors can edit a single document once the main outline has been created. | ||
##This is an iterative process, and manuals will be updated with time. They are versioned, live documents intended for live, collaborative, online, and realtime editing throughout their life. The life of a document never ends - a document can always be updated. Versioning and [[Genealogies]] are used to keep track of build versions. | ##This is an iterative process, and manuals will be updated with time. They are versioned, live documents intended for live, collaborative, online, and realtime editing throughout their life. The life of a document never ends - a document can always be updated. Versioning and [[Genealogies]] are used to keep track of build versions. | ||
Revision as of 18:58, 24 May 2019
Manual Production
In general OSE's open source product development relies on roles being selected via Meritocratic Do-ocracy. We suggest creating manuals as a 3 step process.
- Write the main script with content and outline, using a basic template that contains OSE style and branding
- Use OSE Manual Template for the cover page to describe the manual and provide a QR Code for online access for people who are using printed or online copies of the manual.
- Use a Manual Index Template found in the template below for the Index
- Use basis formatting ONLY in the following pages, using the Manual Content Template below. This is because subsequent editing will produce the final formatted copy, and time would be wasted if format editing is applied prior to most of the content being created.
- The lead editor sets up the Cover Page and Index.
- Large numbers (100s to 1000s) of contributing editors can edit a single document once the main outline has been created.
- This is an iterative process, and manuals will be updated with time. They are versioned, live documents intended for live, collaborative, online, and realtime editing throughout their life. The life of a document never ends - a document can always be updated. Versioning and Genealogies are used to keep track of build versions.
- Bulk editing by a large, realtime, collaborative group. All that is required is that contributors know How to Edit the Wiki, How to Edit Google Docs, and How to Embed Documents on a Wiki.
Master
This is an annotated template with OSE styling. Use this template if you are contributing to OSE work. Delete the comments and fill with relevant content.
Links
- Source work by Jean-Baptiste Vervaeck - Jean-Baptiste_Log_-_2014#Tuesday.2C_1_Time_log