Warning: This page has not been updated in over over a year and may be outdated or deprecated.
community:documentation_maintenance
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revisionNext revisionBoth sides next revision | ||
community:documentation_maintenance [2024/03/20 19:32] – created demiankatz | community:documentation_maintenance [2024/03/20 19:39] – demiankatz | ||
---|---|---|---|
Line 5: | Line 5: | ||
Maintaining useful and accurate documentation helps to ensure the health and sustainability of the project. This page describes how the VuFind® project maintains its documentation. | Maintaining useful and accurate documentation helps to ensure the health and sustainability of the project. This page describes how the VuFind® project maintains its documentation. | ||
- | ===== Annual Wiki Review ===== | + | ===== Annual |
- | Each year, members of the [[community: | + | Each year, members of the [[community: |
==== Popular Page Review ==== | ==== Popular Page Review ==== | ||
- | Based on web analytics gathered using Matomo, data from the prior calendar year is used to identify (at minimum) the 50 most popular pages on the wiki. These pages are distributed to PMC members with appropriate expertise for review, and are checked for accuracy. | + | Based on web analytics gathered using Matomo, data from the prior calendar year is used to identify (at minimum) the 50 most popular pages on vufind.org. These pages are distributed to PMC members with appropriate expertise for review, and are checked for accuracy. |
==== Outdated Page Review ==== | ==== Outdated Page Review ==== | ||
Line 19: | Line 19: | ||
==== Release-Specific Note Cleanup ==== | ==== Release-Specific Note Cleanup ==== | ||
- | Some documentation includes specific notes for different releases of VuFind®. Any version-specific notes referencing releases more than five years old are removed. When saving the removal of these notes, an appropriate description (e.g. " | + | Some documentation includes specific notes for different releases of VuFind®. Any version-specific notes referencing releases more than five years old are removed. When saving the removal of these notes, an appropriate description (e.g. " |
+ | |||
+ | It is appropriate to retain information about earlier versions in some circumstances; | ||
+ | |||
+ | ===== Learning VuFind® Review ===== | ||
+ | |||
+ | The [[https:// | ||
+ | |||
+ | ===== Video Review ===== | ||
+ | |||
+ | There is not yet a process for reviewing (and potentially re-recording) video tutorials. This is another topic for future consideration. | ||
---- struct data ---- | ---- struct data ---- | ||
properties.Page Owner : | properties.Page Owner : | ||
---- | ---- | ||
community/documentation_maintenance.txt · Last modified: 2024/04/16 17:56 by demiankatz