2 ms·
Don't have technical documentation -- instead have - design documentation which has a date, and it is understood that it is correct at the time of writing but
by jjgreen 3y ago
Don't have technical documentation -- instead have
- design documentation which has a date, and it is understood that it is correct at the time of writing but will age and become less accurate with time
- clear code with comments on the sharp corners
- ardalanpouya 3y agoHow is design docs different from technical docs?
- jjgreen 3y agoThey are not updated, on purpose. This is the design now.
- ardalanpouya 3y agoIs that ideal for example for onboarding new developers? Our challenge is we are are starting to hire but we also move very fast and every time we refer people to our onboarding docs, they come back confused because some essential thing is now deprecated.
- jjgreen 3y agoHence clear code with comments on the sharp corners
- Double_a_92 3y agoDesign docs are for the developpers. Technical docs could also be for the users, by e.g. ending up in some manual or so.
- ardalanpouya 3y agoSorry. In that case I used a bad word. I probably should have said internal docs that explain some specific flow or behavior of the system. A good example is one that onboards new devs.