Ranter
Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Comments
-
asgs112786yIn agile world, documentation has got no time and love.
In a better uncrazy world, documentation does get attention and rightfully so. -
@asgs it will only be about how what I wrote works though right?? Like Im not going to need to write multiple paragraphs explaining why it interests the customer, then 2 pages later need to justify why it interests the customer
-
asgs112786y@LavaTheif I don't know what sort of doc you are writing, but I'm talking about READMEs, Getting Started, Dive Deep Into Internals, etc.,
-
@asgs im talking about a word document (or as my teacher likes to call it, e-portfolio) that explains what it does, why its done like that, results of various tests and evidence of it working.
The computing one also includes things like modelling the flow of functions and things evidence of how we found out what to do.
Edit: its the same teacher for both subjects, but I think its the exam boards making us do the writing not him. -
@asgs i guess so, if thats what they are called, but is it normally done in industry? I can do a read me, but doing this for everything I need to do sounds like so much.
-
Documentation is everything. If you replace someone who got hit by a bus, but they didnt document anything, you'll want to hit them with a bus again.
-
If you start to develop anything certified, you will get orders of magnitude MORE in documentation.
Nobody lets some dev hack together shit and then launch that for e.g. medical or aviation.
So I'm sitting here, one monitor has a project I am working on for computing, which once done, I need to write somewhere between 30 and 70 pages of documentation, and the other screen has a half completed 6 page documentation for a game I made in Game Dev.
If I go into backend programming, am I really going to need to do all this documentation or is it just one of them things that colleges do that has no relations to reality?
(Also if I go to uni, will I need this level of documentation there too?)
question