3 ms·
> Know why you are creating your docs > Know who your target audience is > Know what their pain points are > Improve your docs over time I think the biggest pr
by tqi 3y ago
> Know why you are creating your docs
> Know who your target audience is
> Know what their pain points are
> Improve your docs over time
I think the biggest problem I've seen with docs is that we tend to overload docs with multiple, sometimes changing audiences in the hopes that fewer docs = less complexity and organizational debt to maintain. Unfortunately the result is that the doc is either too long or too high level to be useful to anyone. This is one of the areas where I actually think LLMs could deliver an actual paradigm shift (once we figure out design patterns that go beyond the suboptimal "ask your docs a question" implementations that exist today).
- mooreds 3y ago> once we figure out design patterns that go beyond the suboptimal "ask your docs a question" implementations that exist today I'd love to hear more thoughts about this. We've added a LLM to let users ask questions of our docs and have found it very useful. Somewhat surprisingly to me, it's also been useful to employees because it doesn't just answer the question, it also references the source, which includes GitHub issues, videos, docs and forum posts. This lets the employee or user dive in deeper to see if the underlying doc has more context or nuance. It also serves as a single entry point to all those sources, which is easier than visiting each.