User:TBurmeister (WMF)/Sandbox/Assessment

Ideas and examples of collection assessment criteria and topics, gathered from analysis of the resources listed in https://phabricator.wikimedia.org/T313037.

Types of information / doc types
For collections focused on a tool, extension, or software component:
 * Quick start guides with sample projects such as TODO apps. Should be able to clone the project from GitHub.
 * Tutorials:
 * "animated form of learning that aids imaging things. Help to understand how the flow works."
 * "High level tutorials (show relevant documentation for problem solving)"
 * README:
 * "a library would have: readme, clear purpose, staffed"
 * "basic 'how to run the code…' doc in github README"
 * Contact info: to get in touch with experts, ambassadors, mentors, or any human who can help in the topic area.
 * Connection to code: link to relevant repos from on-wiki docs (see more in "Findability" section below)

Content formats

 * Beginners - Live learnings, video + picture format. "I want to learn through memes."
 * Visual learning experience. "MediaWiki has documentation, but reading huge pages is not fun. Videos / Visual learning is useful to get information quickly."
 * "Make Youtube videos"

Grouping related content
Landing pages:
 * All documentation in a given collection should link back to a central portal or landing page
 * Creating on-wiki landing pages that link to off-wiki docs.

Connecting code and docs

 * Ideas like: continuous integration that looks for the patch ID in an edit summary, publishing wiki docs with an “open patch” label that can be removed once the patch is merged.
 * Ideas like: continuous integration that looks for the patch ID in an edit summary, publishing wiki docs with an “open patch” label that can be removed once the patch is merged.

Transparency

 * Access to documents should NOT be restricted for viewing by target users (aka remove or update permissions as necessary).