Other planned features
Like the video says, this is just a proof of concept of the writing interface, I wanted to make sure that part was even possible before moving on.
I'm also planning to add:
- Search audit - This would be an area in the control panel that would list any search queries that have been entered on your documentation that either didn't yield any results, or had results, but none were clicked. This would allow you to add extra tags/keywords to your docs to help users find them, or even create new docs you may not have realised you needed. Only the search query and what was clicked will be stored, no personal information about the searcher.
- User specific variables - eg: if your user was reading a page about using your API, you could add something like {{API_KEY}} to your docs, and then pass in the current users's public API key when the docs are loaded. The user's actual API key would be included in the docs, making it easier for them to copy and paste sample code, etc. (and there'd be a fall back dummy value when viewing the docs while logged out)
- Stale article/file notifications - Another issue I've faced is remembering to keep docs up to date. This would be an area in the control panel that lists all your articles and files, ordered by the least recently updated first. You could also specify a notification period. Eg: 3 months. If any docs haven't been updated for that long, you'd receive an email asking you to confirm it's still up to date.
There are some other planned features listed below, these are just the ones I felt warranted a detailed explanation