Future of Coding is an online community with a welcoming, cooperative, and revolutionary spirit. We are unified in the belief that the common practice of programming is tragically less humane than it could be.

Future of Coding

Does anyone know of interesting projects or research re. keeping product documentation (esp. structured to correspond with a UI) is sync with codebase changes?

My mind goes to docstring-and-docstring-adjacent tools for documenting code, but documenting code for reuse seems like a distinct task from generating product documentation for a nontechnical reader.

I’d be very interested in what you find! I’ve had this problem come up a lot in my work as a developer experience contractor, with various clients trying to auto generate docs for APIs based on swagger/openAPI specs etc and finding the promise doesn’t quite play out

My central curiosity: I'd expect documentation for a library to be nearly isomorphic (using the term very loosely) to the code at that abstraction layer. Entries for exported functions; subentries documenting arguments; etc.

Product documentation is still _likely_ to be coupled, but more loosely. Kind of a Conway's Law for interfaces.