|
I document as I go. You should see the docs included in my MVC5 app project template. Over 30 HTML files, and half a dozen visio docs that describve what the code does, why it does it, and where to find the various components. I do admit to roundly trashing Entity Framework (that took two files). In many of the files, there are almost as many comments as there are lines of code.
Nobody will be able to complain (much) that I didn't document something. I've never been accused of not leaving enough transition documentation behind.
".45 ACP - because shooting twice is just silly" - JSOP, 2010 ----- You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010 ----- When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013
|
|
|
|
|
Other than EF, that sounds like a project I might want to inherit.
As opposed to one recent job I inherited, where I had to track down the personal email address of the dev to shake him down for even the passwords he used on the system. I'm assuming that wasn't a "leaving on good terms" example.
TTFN - Kent
|
|
|
|
|
At my last job, I left docs for every one of the 200+ SSIS packages I wrote (including the the source file being imported, the parameters sent to the package, and the associated stored procs that executed transform duties, and even the names of the stake holders), and as much as I hated doing it, documented all of the ETL stuff in the 20+ QlickView "apps" I wrote. Docs included docx, vsdx, and xslx docs as well.
I documented as I went, so the two weeks prior to me leaving was simply cleaning up and making sure I had covered everything. I guess I hope that the universe will pay me back in the next job I get (it has yet to happen, though).
|
|
|
|
|
More likely some newly hired kidiot will delete all your docs because all good code should be fully self-documenting and the stupid word docs, visio diagrams, and comments won't update themselves; and then a few weeks/months later will be desperately trying to contact you to explain how to fizzbuzz; resulting in an rant about stupid people showing up here.
Did you ever see history portrayed as an old man with a wise brow and pulseless heart, weighing all things in the balance of reason?
Is not rather the genius of history like an eternal, imploring maiden, full of fire, with a burning heart and flaming soul, humanly warm and humanly beautiful?
--Zachris Topelius
Training a telescope on one’s own belly button will only reveal lint. You like that? You go right on staring at it. I prefer looking at galaxies.
-- Sarah Hoyt
|
|
|
|
|
I currently work in a no-comments environment with a huge codebase for software that is highly customisable.
The old guard seem to almost take pride in being able to exclaim that they do not understand what much of the system does
While it's always a matter of degree I think comments are extremely helpful.
“That which can be asserted without evidence, can be dismissed without evidence.”
― Christopher Hitchens
|
|
|
|
|
Kent Sharkey wrote: "When you leave your old job on good terms"
And Kent branches out into fiction. No wonder everyone want to shut him down.
|
|
|
|
|
Joe Woodbury wrote: And Kent branches out into fiction. No wonder everyone want to shut him down. That's not fiction; sometimes you buy your coworkers something nice to eat, to say goodbye.
Bastard Programmer from Hell
If you can't read my code, try converting it here[^]
"If you just follow the bacon Eddy, wherever it leads you, then you won't have to think about politics." -- Some Bell.
|
|
|
|
|
Kent Sharkey wrote: Bridges burned? Check! I take it project-transfers aren't being teached anymore?
Of course, the "industry" want devs that can negotiate and collaborate?
Bastard Programmer from Hell
If you can't read my code, try converting it here[^]
"If you just follow the bacon Eddy, wherever it leads you, then you won't have to think about politics." -- Some Bell.
|
|
|
|
|
Kent Sharkey wrote: When you leave your old job on good terms". That does happen sometimes, right? |
Absolutely! When I was working as an expat in Venezuela, I foresaw the impending disaster and decided it was timed to get out, but I no problem with the company that always treated me well, or my coworkers, many of whom I trained. I gave a 1 year notice and worked on the transfer of my duties. Years later I had a consulting job were the supervisor in charge was one of the people who took over for me. I was glad I had left on good terms!
CQ de W5ALT
Walt Fair, Jr., P. E.
Comport Computing
Specializing in Technical Engineering Software
|
|
|
|
|
It's the first tool that can directly translate speech from one language into another. Does this translation make me sound Belgian?
Yes, not a language. But it was the first thing that popped into my head.
modified 15-May-19 17:07pm.
|
|
|
|
|
Lets have a Turkey in Turkey.
Find me an AI that recognizes the meaning.
Bastard Programmer from Hell
If you can't read my code, try converting it here[^]
"If you just follow the bacon Eddy, wherever it leads you, then you won't have to think about politics." -- Some Bell.
|
|
|
|
|
An entire class of vulnerabilities in Intel chips allows attackers to steal data directly from the processor, according to new reports from a group of cybersecurity researchers from around the world. Intel, Apple, Google and Microsoft among other tech giants have released patches to address the flaws. Request permission to panic?
|
|
|
|
|
I question someone actually being able to pull off a successful attack on a system not doing just one thing.
|
|
|
|
|
any computer more complex than a stop light controller is doing more than 'one thing', these days.
|
|
|
|
|
In the wake of March's terrorist attack in Christchurch, New Zealand, Microsoft is partnering up with other tech giants to counter extremist content online. "Terminate with extreme prejudice"
|
|
|
|
|
That nasty Kent is in their cross hairs.
|
|
|
|
|
|
Who gets to decide what is "extreme" content? These days you are called a racist or a Nazi for pretty much everything the regressive-left dislikes. This sounds like censorship under the guise of safety.
Let's be honest, Silicon Valley is a harbour of regressive-left politics, so this seems like a way of shutting down all dissenting opinions and views whilst telling us it's for our own good.
And why only in the wake of the Christchurch attack? Why not in the wake of the Sri Lankan attack which killed far more people (I think we all know the answer to that though).
"There are two ways of constructing a software design: One way is to make it so simple that there are obviously no deficiencies, and the other way is to make it so complicated that there are no obvious deficiencies. The first method is far more difficult." - C.A.R. Hoare
Home | LinkedIn | Google+ | Twitter
|
|
|
|
|
Dominic Burford wrote: Why not in the wake of the Sri Lankan attack
Easter Worshipers aren't a protected class.
|
|
|
|
|
Dominic Burford wrote: These days you are called a racist or a Nazi for pretty much everything the regressive-left dislikes.
Normal person: "Erm, are you sure a trade war with China makes good economic sense?"
Right-winger: "Mummy! Mummy! He called me a Nazi!"
You could maybe save your tired snow-flakery and political correctness for The Soapbox.
Whenever you find yourself on the side of the majority, it is time to pause and reflect. - Mark Twain
|
|
|
|
|
PeejayAdams wrote: Normal person: "Erm, are you sure a trade war with China makes good economic sense?"
Right-winger: "Mummy! Mummy! He called me a Nazi!"
Name-calling is always the first stop on the liberal railroad.
PeejayAdams wrote: You could maybe save your tired snow-flakery and political correctness for The Soapbox.
But he's correct.
".45 ACP - because shooting twice is just silly" - JSOP, 2010 ----- You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010 ----- When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013
|
|
|
|
|
|
It’s well known that some countries are unhappy with the Western coalition that has traditionally held sway over internet governance. internet++?
|
|
|
|
|
And by some countries, we mean China and North Korea.
|
|
|
|
|
If you find yourself learning C# and .NET and come upon the "Run your first C# Program" documentation you may have noticed a "Try the code in your browser" button that lets you work through your first app entirely online, with no local installation! You're running C# and .NET in the browser! It's a great way to learn that is familiar to folks who learn JavaScript. If it's good enough for JavaScript, it's good enough for C#
|
|
|
|