Usually, technical documentation is for other developers and/or administrators.
Imagine:
a) you are a new developer joining a software project. What kind of information would be useful to get introduced to the project.
b) you are an administrator who needs to maintain a software product. What kind of information would be useful (e.g. in case of errors, ...).
a)
- coding / naming conventions
- how to run / build / deploy the application
- maybe an overview of the architecture
- its place in the system landscape (which other systems interact with it)
- ...
b)
- Where the log file is located
- How to configure the application
- How to restart / deploy it
- ....
Hi everyone! I have a quick question. Do any of you have a really good example or template of "Software development Technical documentation"? It should include clients' requirements for software, design decisions, architecture and technical/coding part descriptions etc.
I would be glad to receive any help from you, thanks :)
What is technical documentation in software development?
What are the types of software documentation?
What documentation generators or static site generators do you use? What's your favorite?
I'm writing about top 10 documentation with pros and cons of them. I could just make up some them, but I want to give fair comparison. I'm using Nextra, so I know how their pros and cons, but I want to learn more about others.
Furthermore, I would love to hear your experience with documentation generators you are using.
Usually, technical documentation is for other developers and/or administrators.
Imagine:
a) you are a new developer joining a software project. What kind of information would be useful to get introduced to the project.
b) you are an administrator who needs to maintain a software product. What kind of information would be useful (e.g. in case of errors, ...).
a)
- coding / naming conventions
- how to run / build / deploy the application
- maybe an overview of the architecture
- its place in the system landscape (which other systems interact with it)
- ...
b)
- Where the log file is located
- How to configure the application
- How to restart / deploy it
- ....
There is, alas, no generally agreed set of documents (and their templates) that all companies follow. Some may employ a project management methodology like SSADM, Prince 2, Agile etc, but even then, it can be highly customized to the business.
What you're really describing here is what you've already alluded to - it is a technical document. What you put in here really depends on the type of project. Even if you design yourself a specific template, the sections will vary widely depending on whether you're writing a console app, a web application or whatever.
Maybe try getting a steer to see what else has been written already and try to follow that.
If you're really a trail blazer, you'll need to keep a firm hand on the document as various audiences will want all sorts of stuff added so you need to be careful it doesn't suddenly morph into a training document or user manual etc.