MediaWiki

Documentation/Documentation types

< Documentation

Documentation types are useful concepts for organizing and maintaining documentation. This page describes the types of documentation found in Wikimedia technical docs.

Scope

edit
  • In scope:
    • Wikimedia technical documentation
    • documentation about collaboration and processes for Wikimedia technical projects
    • documentation about collaboration and processes for Wikimedia content projects
  • Out of scope:
    • wikimediafoundation.org
    • legal documentation
    • project content, like Wikipedia articles and Wiktionary entries
    • web apps
    • blog posts

Terms

edit
documentation type
the structure and goal of a documentation page

List of documentation types

edit

This is an uncurated list of documentation types with notes, examples, and related links.

Cataloging docs

edit

How can we track documentation pages by content type?

Categories

edit

For documentation on wiki, we can use categories, such as Category:Tutorials to indicate and track documentation types.

In order for this strategy to be effective, obsolete or historical pages must not be included in these categories. Based on Project:Schools of thought on deletion, removing categories from obsolete pages could be a good compromise between inclusionism and deletionism. Categories can act as part of the curation layer, while historical pages can still be accessed via search. As of April 2023, there are several obsolete or historical pages included in Category:Tutorials.

Alternatively, we could find a way to search for pages in a content-type category but not in Category:Outdated pages or Category:Pages kept for historical interest. I wasn't able to find an easy way to do this, the closest being searching for pages without the word "outdated", which doesn't work because it's catching any use of "outdated", not just the template.

Machine-readable directory

edit

Since documentation pages are stored in a variety of locations, not just on wiki, we need a method of tracking docs across platforms. I've started gitlab:apaskulin/documentation-directory to experiment with tracking docs with YAML definitions.

Prior art

edit

Key doc review process

edit

2021-2022

From Documentation/Review_template#Content_types:

  • Landing page: Landing pages are link hubs that help the reader find information. Landing pages are navigation oriented.
    • Cross-collection landing page
      I found the distinction between landing pages and cross-collection landing pages to be too complicated, so I stopped using the later.
  • How-to guide: How-to guides are directions that take the reader through the steps required to solve a real-world problem. How-to guides are goal oriented.
  • Tutorial: Tutorials are lessons that take the reader by the hand through a series of steps to complete a project. Tutorials are learning oriented.
  • Explanation: Explanations are discussions that clarify and illuminate a particular topic. Explanations are understanding oriented.
  • Reference: References are technical descriptions of a system and how to operate it. Reference documentation is information oriented

Audit of key technical docs

edit

2021-2022

From spreadsheet (restricted access):

  • web app
  • blog post
  • code repository
  • contributing guide
  • explanation
  • how-to guide
  • landing page
  • readme
  • tutorial
  • overview
  • guidelines
  • metrics dashboard
  • portal
  • process description
  • team page
  • user group page

Documentation/Patterns

edit

2022

"Patterns" was too obscure of a name for this.
  • The lists of examples with links is helpful. What information can we include to help users decide which examples will be helpful to them?
  • The lists of elements in the "Description" section are too long and hard to parse. I can see using this for an automated linter that checked for the presence of these elements, but not for human use.
  • The lists of templates and availability are difficult to create and maintain, but very useful. They remind me of browser compatibility charts. Can we automate this? Should we create tasks for importing some of these to missing wikis?

Documentation/Toolkit

edit

2022

Documentation/Toolkit#Use_templates_to_create_documentation

Are API docs and library docs documentation types? I think of API docs as a general term for all the documentation required for an API, including an introduction, reference, tutorial, and explanation. See Documentation/API_documentation#Types_of_API_documentation.

See also

edit

References

edit
Retrieved from "https://www.mediawiki.org/w/index.php?title=Documentation/Documentation_types&oldid=6335465"