You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In early Projects here on GitHub, we use the simple Kanban To Do, In Progress, and Done for aligning issues with the project(s) they contribute to.
For personal writing of digital materials, that might be sufficient. Document Engineering might be recognized in some patterns applied in a solo effort. I do that. For coordinated effort in a collaboration, there will be more stages and ways to account for the work, involving oversight by an editor-in-chief, area editors, copy editors, authors and researchers.
For document-production operations there will be more stages, including creation of drafts, rinse-repeat on the drafts and reviews by editors and others. There is also the eventual movement from editable source to final-form, such as a PDF and there might be a continuous integration process that operates across stages of drafts, released versions, and lifecycle considerations thereafter (errata, etc.).
There are dimensions to all of this. This note and additions that others add in comments here are intended to enrich the landscape within which document engineering is applied.
Starters
working language of the project
language(s) of the produced document and collateral materials
Translations to other languages
Style requirements (not word-processing styles), not unlike style guides such as "The Chicago Manual of Style," and technical style guides, some quite project specific (describing actions at a computer, naming features of interfaces, etc.), voice (we, you, or just do)
templates and word-processing styles
accessibility of digital forms
accessibility of the document engineering activity.
mixed media (extreme case: producing a cinematic quality computer game)
help guidance (on the web or incorporated in a software product)
cover art
indexes and tables of content
bibliographic references
images and drawings, graphics
spell and grammar checking
cross-referencing
outlines, sketches, and units of authored contributions
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
In early Projects here on GitHub, we use the simple Kanban To Do, In Progress, and Done for aligning issues with the project(s) they contribute to.
For personal writing of digital materials, that might be sufficient. Document Engineering might be recognized in some patterns applied in a solo effort. I do that. For coordinated effort in a collaboration, there will be more stages and ways to account for the work, involving oversight by an editor-in-chief, area editors, copy editors, authors and researchers.
For document-production operations there will be more stages, including creation of drafts, rinse-repeat on the drafts and reviews by editors and others. There is also the eventual movement from editable source to final-form, such as a PDF and there might be a continuous integration process that operates across stages of drafts, released versions, and lifecycle considerations thereafter (errata, etc.).
There are dimensions to all of this. This note and additions that others add in comments here are intended to enrich the landscape within which document engineering is applied.
Starters
Beta Was this translation helpful? Give feedback.
All reactions