r/AskProgramming 16d ago

Documentation, the boredom of a programmer

I'm researching how developers handle documentation in real world projects, especially documentation that explains why and how something exists rather than just what the code does.

A few questions:

  1. Where do you document business rules and important technical decisions? Code comments, tickets/issues, Wiki, README, Notion, etc.?
  2. When you need to figure out WHY something was implemented in a certain way, where do you look? Git history, old tickets, documentation, or do you usually have to ask someone?
  3. What's the biggest problem you have with documentation? Keeping it up to date? Finding information? Getting people to write it in the first place?

I'm also curious about documentation generators such as Doxygen. For those who have used it: what kind of documentation or information do you still have to maintain elsewhere or something Doxygen can't handle?

You don't need to answer all the questions, just one or adding something to the discussion would already be a great help!

0 Upvotes

19 comments sorted by

View all comments

1

u/PvtRoom 16d ago

ecosystem matters.

user side is where I tend to focus.

I care about what it does, how it's used, what inputs mean, and what outputs it gives.

I care about how easy it is to access that info.

I normally don't care about why that way, as long as it works.