Nice article. As a technical writer, I have seen many developers struggle with documentation - internal and external.
I think your suggestions of using a Docs-as-Code approach is very good. It is more familiar and can be used in known environments.
Also, devs could use tools like Doxygen to document APIs directly in their header files, as special comments. This is mostly used for end-user documentation, but why not use it for internal purposes, too?
Thank you, Andreas! I used JSDoc and TSDoc which seem similar to Doxygen, and it was great even for internal documentation purposes. I’ll check out Doxygen.
We used doxygen for C++ and Embedded C. For the most part, it worked ok. It needed the occasional tweak and syntax validation with Eclipse was a pain. But maybe that qas just our customized tooling.
Nice article. As a technical writer, I have seen many developers struggle with documentation - internal and external.
I think your suggestions of using a Docs-as-Code approach is very good. It is more familiar and can be used in known environments.
Also, devs could use tools like Doxygen to document APIs directly in their header files, as special comments. This is mostly used for end-user documentation, but why not use it for internal purposes, too?
Thank you, Andreas! I used JSDoc and TSDoc which seem similar to Doxygen, and it was great even for internal documentation purposes. I’ll check out Doxygen.
You're welcome.
We used doxygen for C++ and Embedded C. For the most part, it worked ok. It needed the occasional tweak and syntax validation with Eclipse was a pain. But maybe that qas just our customized tooling.