Post History

Source: https://writers.stackexchange.com/q/47399
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/

Good time of the day, community!

Hope, that my post won't irritate too much, but rather will be helpful for someone in future.

I already made some progress myself (I mean some raw unfinished version of the technical document), and searched across the web - but any extra hints will be welcomed.

Below, I will give a sequential abstract (but precise) description.

**What I have:**

On my current work I have a web-service. It has:

1. some user interface

2. some validation done in fill-in forms within that interface (on frontend level)

3. list of variants for some of the fields, that are being queried from some internal database using specific sql-conditions

4. backend logic for processing submitted forms

5. backend/database logic for storing information from submitted info

6. some frontend logic for retrieving already submitted info

7. probably something else technical that I have forgotten to mention

**What I need to do:**

I need to compose a technical description (with text, tables and probably diagrams) of how the system works (both frontend and backend).

**Why do I need it:**

We _(me, system analyst, and my team of my supervising manager and developers)_ are going to get this description. Then we are going to look at it, and brainstorm what we can and/or shall change. Then I will make a technical design for things we are going to change/add (if there will be any).

**What issues I encountered:**

1. I can't really find any example of (or method for) such document, that would be well-designed and not-so-difficult to understand.
2. I was looking for some online courses on that, but all of them look very generic.
3. Both points "1" and "2" above refer to technical description document I need to make now, and technical design document - in future.

Hope for some of your help. And, as I usually say, response is appreciated, ignorance will be understood.

Original score: 5