Difference between revisions of "Documentation"
(Created page with "Content produced to pass on data, information, knowledge and know how about a process or a thing. This activity may require harvesting (a capturing mechanism),...") |
|||
| Line 1: | Line 1: | ||
Content produced to pass on data, information, knowledge and [[know how]] about a [[process]] or a thing. | Content produced to pass on data, information, knowledge and [[know how]] about a [[process]] or a thing. | ||
| − | This activity may require [[harvesting]] | + | This activity may require [[harvesting]] a [[capturing mechanism]]), a support (digital of physical), formatting (or structuring), storage (ex. database, see also [[repository]]) with an associated (file) format. |
| − | Documentation can also be seen as an [[accumulation mechanism]], and is considered as a form of wealth. | + | Documentation can also be seen as an [[accumulation mechanism]], and is considered as a form of wealth. For example, a context of work, a [[project]], a [[venture]], a network, can be seen as a flow-through [[organization]], for instance [[agents]] enter, spend some time contributing and exit, and carry with them [[resources]]. We can use the metaphor of a river, carrying various materials. In some places the river flows rapidly and nothing much gets deposited locally. In other places, the river slows down and stuff can be deposited. As vegetation starts growing, it acts as as a barrier or a filter for some materials, consisting a [[capturing mechanism]], slowing the river even more and having even more stuff getting deposited locally. Ecosystems are formed around these areas, with an increase in diversity. This metaphor can be applied to an [[organization]], which is a local context through which [[agents]] flow and carry with them [[resources]] and engage in generative [[processes]], creating new stuff. The [[organization]] must put mechanisms in pace to slow down the flow and capture more stuff from [[agents]] in that context. As more stuff gets deposited the organization as a place becomes [[valuable]] in the eyes of other [[agents]], because whatever is deposited may have a use / importance for them. Thus, as stuff gets more deposited more [[agents]] are attracted towards the [[organization]] to contribute and create more stuff. Documentation is part of the stuff that gets deposited. Imposing documentation through [[governance]], incentivizing documentation by offering various types of rewards / [[benefits]], facilitating documentation by providing tools (ex. Google Docs) are measures that must be taken to increase the [[wealth]] of an [[organization]], to make it more valuable.. |
Documentation is also related to the concept of [[adjacent possible]], which is a thing that can be created by combining already existing things and perhaps adding a new ingredient to it. In the [[open source]] world this is also called [[remixing]]. The wealth of [[adjacent possible]]s is related to innovation capacity. This is one of the economic advantages of open networks that relay on open collaboration and [[open innovation]] (open source development) | Documentation is also related to the concept of [[adjacent possible]], which is a thing that can be created by combining already existing things and perhaps adding a new ingredient to it. In the [[open source]] world this is also called [[remixing]]. The wealth of [[adjacent possible]]s is related to innovation capacity. This is one of the economic advantages of open networks that relay on open collaboration and [[open innovation]] (open source development) | ||
| Line 9: | Line 9: | ||
Documentation can be construed as [[digital assets]] and requires discoverability (see [[transparency]]), accessibility (see [[openness]]), portability and interactivity. | Documentation can be construed as [[digital assets]] and requires discoverability (see [[transparency]]), accessibility (see [[openness]]), portability and interactivity. | ||
| − | The documentation process requires [[methods]], norms (see [[governance]]) and tools. | + | The documentation process requires [[methods]], norms (see [[governance]]) and tools. |
| + | |||
| + | =Types of documentation= | ||
| + | |||
| + | ==Following development processes== | ||
| + | |||
| + | [[File:Documentation acording to process.jpg|thumb]] | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
Revision as of 03:58, 28 June 2023
Content produced to pass on data, information, knowledge and know how about a process or a thing. This activity may require harvesting a capturing mechanism), a support (digital of physical), formatting (or structuring), storage (ex. database, see also repository) with an associated (file) format.
Documentation can also be seen as an accumulation mechanism, and is considered as a form of wealth. For example, a context of work, a project, a venture, a network, can be seen as a flow-through organization, for instance agents enter, spend some time contributing and exit, and carry with them resources. We can use the metaphor of a river, carrying various materials. In some places the river flows rapidly and nothing much gets deposited locally. In other places, the river slows down and stuff can be deposited. As vegetation starts growing, it acts as as a barrier or a filter for some materials, consisting a capturing mechanism, slowing the river even more and having even more stuff getting deposited locally. Ecosystems are formed around these areas, with an increase in diversity. This metaphor can be applied to an organization, which is a local context through which agents flow and carry with them resources and engage in generative processes, creating new stuff. The organization must put mechanisms in pace to slow down the flow and capture more stuff from agents in that context. As more stuff gets deposited the organization as a place becomes valuable in the eyes of other agents, because whatever is deposited may have a use / importance for them. Thus, as stuff gets more deposited more agents are attracted towards the organization to contribute and create more stuff. Documentation is part of the stuff that gets deposited. Imposing documentation through governance, incentivizing documentation by offering various types of rewards / benefits, facilitating documentation by providing tools (ex. Google Docs) are measures that must be taken to increase the wealth of an organization, to make it more valuable..
Documentation is also related to the concept of adjacent possible, which is a thing that can be created by combining already existing things and perhaps adding a new ingredient to it. In the open source world this is also called remixing. The wealth of adjacent possibles is related to innovation capacity. This is one of the economic advantages of open networks that relay on open collaboration and open innovation (open source development) when compared with traditional firms or other of traditional and bureaucratic institutions. See also about the 4th Sector.
Documentation can be construed as digital assets and requires discoverability (see transparency), accessibility (see openness), portability and interactivity.
The documentation process requires methods, norms (see governance) and tools.
