4 ms·
Trying something new on this month's project: "developer first experience". Besides the README.md to get started, the app defaults to a private portal with a c
by ericclemmons 11y ago
Trying something new on this month's project: "developer first experience".
Besides the README.md to get started, the app defaults to a private portal with a component playground (for React), internal docs (for answering "how do I"), and tools for completely removing the need for doc pages at all.
I believe that documentation has to be part of the workflow, so component documentation should be visible while working on the component, tools for workflow should have introductions and helpful hints rather than being just forms and buttons, etc.
So far, this is proving fruitful.
(Side note: wikis are where docs go to die.)
- brwr 11y agoThanks for the reply! Two questions for you: 1) I agree that documentation has to be a visible part of the workflow, but getting buy-in from the whole team is difficult even with small decisions. What have you done to get your team onboard with writing docs? 2) Why are wikis where docs go to die?
- davidjnelson 11y ago2) perhaps because it's hard to find what you're looking for, and for code they are almost immediately out of date, so why bother. I find getting collaborators subscribed to email updates for changes helps with this problem.