You are browsing a read-only backup copy of Wikitech. The primary site can be found at wikitech.wikimedia.org
User:SRodlund/Toolforge technical documentation improvements
- 1 Overview
- 2 Developer stories
- 3 Evaluation and improvement
- 4 Audiences
- 5 Monthly top page views
- 6 Organization of technical documentation
- 7 Tickets on Phabricator for individual pages
- 8 Key Toolforge pages
- 9 Definitions
- 10 Documentation templates and related visualizations
- 11 Big changes / page improvements
- 12 Tiny to-dos
- 13 Subtle Changes
- 14 Pages I would like to delete
- 15 Pages I would like to see
- 16 Nonpriority pages for update
- 17 Pages outside Wikitech we should update
This page contains thoughts and ideas for creating structured and substantive improvements to Toolforge technical documentation
- I am a new developer and/or new to the Wikimedia ecosystem, and I want to
- I am an experienced developer, and I want to
- I am a new developer and/or new to the Wikimedia ecosystem, and I want to understand what Toolforge is
- I am a new developer and/or new to the Wikimedia ecosystem, and I want to understand what is possible to do with Toolforge
- I am a new developer and/or new to the Wikimedia ecosystem, and I want to understand to how to use Toolforge to create a tool
- I am a new developer and/or new to the Wikimedia ecosystem, and I want to work with others to develop or maintain a tool
- I am an experienced or newer developer, and I want to learn about how other developers have used Toolforge
- I am an experienced developer, and I want to onboard experienced developers who are working on or with Toolforge
- I am an experienced developer, and I want to share information about how to perform a task or complete a process with a less experienced developer
- I am an experienced developer, and I want to find information about how Toolforge works
- I am an experienced developer, and I want to fix something that is broken about Toolforge
Evaluation and improvement
- Site organization and navigability -- Is the site well-organized. Can visitors find their way to the information they need or discover it easily?
- Coverage (Site/Topic level -- Toolforge as a main focus) -- What is the scope of the site/topic? Does it cover the relevant information? Are tangential but irrelevant topics included.
- Page level coverage -- does the page cover a specific topic or is there a hodgepodge of related information? Ideally, pages are focused on one area of coverage.
- Page level organization and navigability -- Do all pages follow a consistent structure? Is it easy to understand the flow of information?
- Readability -- Is the language readable. It should be simple and as low on the Flesh Kincaid scale as possible -- though this can be difficult with technical jargon (https://www.webfx.com/tools/read-able/check.php)
- Memorable -- Is the information memorable? Is it set up for the reader to learn / reference?
- Correct -- Is the information correct?
Monthly top page views
Organization of technical documentation
March 2019 - technical documentation in the Wikitech namespace is not formally organized beyond the usage of categories at this time. Visitors to the site might be confused by its current structure, which visually mimics a more hierarchical website (see main page). Users who do not know the differences between cloud services and tech ops may be confused. Introductory, getting started, and informational portals for different products and services appear on the same main-page. When the visitor clicks through the links on the main page they will encounter pages of vastly different purposes, conveying information in vastly different ways. These pages are basically siloed. Once a user leaves the main page, they are just where they are with little guidance to help them find what they need.
Page level structure
- Are users able to find what they need using the current structure?
- Do pages follow basic templates that effectively convey information?
Language and readability
- Make sure the documentation is written for easy readability. It will be hard to gauge on flesh kincaid w/all the jargon and technical language but keep simplifying and scaling back.
Tickets on Phabricator for individual pages
Key Toolforge pages
- Portal:Toolforge AKA Portal: Tool Labs (Redirected)
- Consistently, the most viewed "toolforge" related page
- Entry point for many seeking information and help about Toolforge
- This page is linked to frequently from outside sources; its content and organization is key.
- Getting Started
- Links to Help/How-to Documentation
- Links to About Documentation
- Links to Reference Documentation
- Why is this called a Portal?
- What are the key reasons visitors come to this page?
- Information about Toolforge?
- For Help and support content?
- By mistake?
- Does the layout/visual design of this page aid users in finding the information they need?
- Image in Toolforge specific navbar is for Cloud Services. Is this confusing?
This is consistently viewed in the top 3 pages on Wikitech PRIORTY
- Make sure this is linked to Toolforge:Portal
- Separate content section into their own pages and create new ones for larger topics.
- Help: Toolforge FAQ
- Make sure this is linked to Toolforge:Poral
Help:At a glance: Cloud VPS and Toolforge
- Help:At a glance: Cloud VPS and Toolforge
- Make sure this is linked under Cloud VPS ad Toolforge Portals
Potential Structure and Content Notes
Toolforge USER help
- Work on this first (sections)
-- For this namespace (Own Navbar of selected stuff) -- Curated category for these pages (TOOLFORGE USER DOCUMENTATION)
Toolforge ADMIN help (under portal but needs to be moved to help)
- Work on second (sections)
-- For this namespace (A navbar of selected information) -- Curated category for these pages (TOOLFORGE ADMIN DOCUMENTATION)
"My First XYZ Tool" should be highlighted under the "How To" section
- What can you do? Ideas based on user stories.
- Merge&redirect this page somewhere: https://wikitech.wikimedia.org/wiki/Help:Toolforge/How_to (It doesn't seem to have a purpose)
- Create a standard template for what information will be on included on the Portal pages at https://wikitech.wikimedia.org/wiki/Main_Page
- Contact information should be included on all help pages, so folks can reach out for support and help.
- Look at the longer pages and give them a minimalist treatment so that they are easier to navigate and read.
- Look for duplicate information in different places on Wikitech; combine.
- Update: https://wikitech.wikimedia.org/wiki/Template:Toolforge_nav
- Look to the Wikipedia "Portal" guidelines for Portal pages on Wikitech (thinking about context and familiarity)
- Template:Portal How does / does the Portal template function on Wikitech?
Spellings | usage
- See also: Help:Glossary
Spelling and usage is not always consistent across the documentation. Here are the current preferred spellings and usages:
- Tool Account (Group Account)
- maintainer (member of a tool account)
- Tool Webpage
- Tool Account (Group Account)
- maintainer (member of a tool account)
- Tool Webpage
- User:Quiddity/doctemplates, list of (all?) documentation-related templates
- Toolhub#Visualizations related to Tools and Account creation
- Images: https://www.mediawiki.org/wiki/Help:Images
Big changes / page improvements
Maybe file Phab tasks. Move to the subtle changes when finished.
- Make sure the links on the Toolforge Navbar on pages in Toolforge Portal link to the correct pages
- Change links in the sidebar to link to the appropriate pages. (https://wikitech.wikimedia.org/w/index.php?title=MediaWiki:Sidebar&action=edit)
- Remove the "See WMCS intro banner" from the top of pages to reduce confusion. WCMS intro is prominently featured from main and easy enough to find
- Make the Getting Started with WMCS page obsolete (It's too confusing for new people)
- Create a small "quickstart" page for Toolforge to link to from Portal
Pages I would like to delete
- https://wikitech.wikimedia.org/wiki/Help:Contents (just confusing and not useful)
- Help: Toolforge FAQ (Would like to combine this information with Help:Toolforge
- Help:Getting_Started -- Don't delete but rethink. This page has mixed coverage, and it can be REALLY confusing for a newcomer who isn't familiar with all the differences between our services and systems. There could be a lot more coverage for this in places that are separated by service/system.
Pages I would like to see
- How to get started with Toolforge - walkthrough w/decision tree
- How to set up an example tool & manage files (detailed w/screenshots)
- Structure -- What is the structure of Toolforge/how does it work/function holistically?
Nonpriority pages for update
- Wikitech sidebar should link to Portal rather than help pages for Toolforge and Cloud VPS