A skim through StackOverflow (using queries like MediaWiki API, Action API, Wikimedia API, etc.) helps us understand what an external user might look for in an FAQ.
A lot of people want guidance on how to use the API. We can point them to API:Tutorial.
Next, folks want information about performing very particular (yet basic) tasks which are mostly covered in the sidebar under 'page operations', 'search', etc. A note on navigation might be useful.
Audience for the FAQ:
- Internal and external developers who want quick answers. (or pointers on where to find the exact answers)
- Users new to MediaWiki's API looking for more information.
- Folks that are stuck somewhere who need help/need information about where to get help.
- Newcomers who lack knowledge about APIs, will need maximum support.
- (Reference: API talk:Main page#Reorganizing action API documentation)
Structure:
- The FAQ can be organized according to the types of users and the questions in the order of importance.
- The answers need to be crisp with links to additional info.
- The task description suggests splitting the FAQ into 3 sections: https://phabricator.wikimedia.org/T205167
- The 'About APIs' section is meant for beginners. It has been listed at the end to maintain MediaWiki Action API as the primary focus. This can be changed based on feedback received.