Feb 16, 2023 · It covers various areas such as system overview, installation and configuration guides, usage instructions, API documentation, database schema, testing, deployment, …

Aug 11, 2023 · Hello! I'm a relatively new technical writer here. Hoping to learn by looking over other docs. I've been trying to learn what I can from documentation I find online, but I'd love to …

Oct 16, 2023 · My go-to for documentation is HelpKit, especially since it leverages Notion to create and manage content, which is a platform many are already familiar with. This approach …

But in order to make good and useful documentation, you need to learn about technical writing. Basically you need to properly define all your concepts, and terminology and use those in a …

May 18, 2023 · How can I, without becoming our "documentation person", improve how my team documents things? Right now, people either document things poorly, or not at all because we …

Mar 18, 2023 · I think management has to clearly recognize creating (and updating) documentation as work, and maybe give special recognition and rewards for excellent …

Apr 19, 2022 · The documentation may not be poorly designed, but you will at least be exposed to a wide range of styles and methods and be able to provide some critiques. As far as I know, …

Dec 24, 2020 · I’m a software engineer that has taken a bigger role in writing technical documentation for my team. When I first started, there was little to no documentation about …

While there's no single governing body like APA or MLA for technical writing, there are general conventions that promote clarity and consistency. Here are some tips to address your specific …

May 27, 2022 · What kind of documentation are you creating? That's the main thing that drives this kind of question. My best tool and your best tool may be very different depending on …