Developers Should Diagram and Document!

Developers Should Diagram and Document!

July 12, 2019 32 By Bernardo Ryan



I want to talk about diagramming and documentation diagramming and documentation when you're building out your website your web apps your applications it's very important that you don't leave out a crucial step of a diagramming out your site so that could be just a bunch of boxes that describe the views something like this these boxes could be also used to describe and break down your object structure if you're writing object-oriented code it could be used to set up the structure between your database tables if you're using an SQL based database it's very useful to have diagrams written down I prefer pen and paper it's just easier for me that way and when you write things down you'll know if you've been doing any of my courses that by writing stuff you activate the tactile sensation and so you're giving your brain multiple inputs which tells your brain but this is more important and this should be worked on and considered you always want to do that you have to understand your brain is like the supercomputer or what is the supercomputer but it's a supercomputer but has to be told or has to be instructed if you will it has to be you have to let it know what it is it should be focusing on and there's certain things that it does one of the things that are pays attention to is how much of stimulus how much input it has coming into it so if you just look at something it's one level of input but if you're looking and writing that's to two sensations that are coming in or two sensory inputs of your well tactile and visual and no I I don't know what percentage is but it increases the perceived importance of that information it's a great way to learn by the way that's why I talk about it in my course I say when you're doing the material take little notes not so that you can review the notes although you could review the notes but you take notes just the act of taking your notes and writing things down or commit things to memory much more quickly than they would otherwise that's number one number two documentation so I just had a meeting with my lead developer who is now working on the studio web for store which is going to replace the killer video store because it integrates with the studio website which is our my learning platform and there's a lot of function out in there there's a lot of functionality in there and in the rush to get things out we're pushing now to we're at the home stretch in terms of releasing to the public adds a whole bunch of new capabilities and a whole bunch of new things that will be bringing to to the world a lot of times what gets lost in the mix is updating your specification your documentation for every application it's gotten to the point where the app is pretty complex and so because the documentation hasn't been maintained as it should we find ourselves at least me anyway I find myself forgetting okay did we implement that and why did we implement and implement that what was the thinking behind that so for example you will find if you get into more complex application development you could find it a very simple decision well a seemingly simple decision could have a chain reaction if you will that is quite complex so you may decide that the way the system calculates whatever a price or eccentric senator could have a huge implication in terms of how you track the data where what that data is going to do long term house and PACs in terms of the performance of the system that's another situation happens yeah so keeping your documentation up-to-date is a very very important thing it should be just it should be considered just as important as the actual code but you write yourself because by having very clean clear documentation it's up to date to allow you to to fill in and find any faults in your architecture much more quickly than you would otherwise finally if it isn't obvious having very good documentation of your feature set the reasoning behind your decisions in terms of your architecture or why you decide to go this route instead of that route in terms of the way the system processes certain information besides this is allowing you to prevent certain problems from occurring so because everything is thought out and put down on paper also well doesn't have to be on paper but you get the idea another huge advantage is onboarding new talent would you have to bring in a new developer to work on a particular module or to replace somebody etc etc it's a thousand times easier for them to get up and running when they have clear well written documentation that describes everything in the thinking behind everything that's done in the application so there you go all right a bit of a hodgepodge video I guess today I'm heading out it's a super nice day gotta enjoy summer while you can when it's cold let me tell you but it's cold you got to enjoy the summer while you can when it's hot because it gets really really really cold in Montreal as you guys probably don't all right we'll talk soon bye bye