3 ms·
We recently did our product wiki page for other teams to integrate with us. Some tips from there: 1. Who is target audience for it. You mentioned detailing you
by zerop 5y ago
We recently did our product wiki page for other teams to integrate with us. Some tips from there:
1. Who is target audience for it. You mentioned detailing your service. So who is going to read it. Write accordingly. If it's for other teams who consume your service, they want to know what is this service, purpose and how to integrate.
2. Think like a startup. Add a one line overview of what it does.
3. Content must be engaging (animated a bit). Images, videos help.
4. Keep the link in your email signature (for promoting it)
5. Ask for feedback and keep updating it.
6. Make it one shop for all team stuff - team page, contact us, paging information of your team when issues
7. If there are other product's wiki, get some inspirations from there.
All the best!