I'm a software engineer, recently i've been doing a lot of small POC for future products (pretty important ones) that we are gonna use. When these POC are validated , some other engineers will work with me on it, i made it and wrote a full documentation (from what it is , how it works, future upgrade, architecture + schemas, database schemas, CI, database migration , naming convention, test etc etc).
He says that what I've done is good and he is happy about it but he keep asking me to do some "abstraction" in my documentations , not simple abstraction like very deep ones like take a restaurant as an example and explain how your project work between the kitchen ,the restaurant etc even though the project and the documentation is only for developers, it's not a product that we sell to anyone or anything like that.
I'm already writing a lot of documentations and even though i do think it's important i think this abstraction thing is too much, i spend a crazy amount of time writing this and i think it's useless (if you want to have some ppt for non technical staff , it's not a problem i can do it but not in that way). he argues that my documentation is technical and not "engineer way".
I cover everything i can think of in my documentation and try to be exhaustive. These POC aren't very advanced stuff for now.
What do you guys think ?
submitted by /u/Mango_Lost
[link] [comments]
from Software Development – methodologies, techniques, and tools. Covering Agile, RUP, Waterfall + more! https://ift.tt/fbM8G3P