Page MenuHomePhabricator

Review and improve: https://www.mediawiki.org/wiki/API:FAQ
Closed, DuplicatePublic

Description

As part of an effort to improve pages for the MediaWiki Action API, we are reviewing some of the most popular documentation pages and editing them for better clarity and readability. https://www.mediawiki.org/wiki/API:FAQ is used frequently by visitors seeking information about the MediaWiki Action API and APIs in general.

Recommendations:

  • Define the appropriate audience for this page? Uncover who is using it and what the needs are of visitors who look for information here. What do they most want to know? Is a FAQ the best format to deliver this information in?
  • After considering audience needs and the format, review the page to determine what information should remain, what is redundant or can be moved to different pages in the API namespace and what should be added to this page to make it more valuable.
  • Rewrite, reorganize, revise, as needed.
  • Review this page with collaborators and site visitors to determine what is working and what is not working.

Event Timeline

srodlund triaged this task as Medium priority.Sep 18 2018, 8:57 PM
srodlund created this task.
srodlund created this object with edit policy "Custom Policy".
Anomie moved this task from Unsorted to Non-Code on the MediaWiki-API board.Sep 19 2018, 1:50 PM
Aklapper changed the edit policy from "Custom Policy" to "All Users".Sep 20 2018, 7:36 AM

srodlund created this object with edit policy "Custom Policy".

Why? Reverted.

Can this task be merged with T205167?

Aklapper edited projects, added User-srodlund; removed Goal.Jun 19 2019, 11:20 AM
Aklapper removed a subscriber: User-srodlund.

Good catch, let's merge