4 ms·
> However this time I didn’t rush to implement, thanks mainly to the influence of Ed Ashcroft. In retrospect Ed’s first impulse when he had an idea was to docum
by kccqzy 7y ago
> However this time I didn’t rush to implement, thanks mainly to the influence of Ed Ashcroft. In retrospect Ed’s first impulse when he had an idea was to document, not implement. We produced a series of widely read papers and soon had other researchers and brilliant students of our own working on it.
I'm not sure this actually applies to most people. The document vs implement struggle is something I see in modern software shops a lot. It certainly depends on the personality: some people just like thinking through everything and producing a coherent writeup before writing a single line of code, but for some writing code itself is an act that clarifies the still-murky concepts and helps to produce a good writeup.
But in the end, most people aren't producing novel enough technologies that the benefit of a complete writeup is there. You don't write something brilliant and have other researchers work on it; you merely write something for the benefit of a future colleague understand your code quickly. It's a very different class of software development.
- jasonpeacock 7y agoMost modern software shops don't document at all. They would definitely benefit from writing down a problem statement and description of the solution so that everyone is on the same page. Documenting doesn't have to mean design-first development, it's a way to make sure you're working the right problems and building the desired solutions before you waste your time writing code.
- mgkimsal 7y agoI've tried to force myself to write something in English before coding, and... it's not 100% followed, but it's often helped. Sometimes I'm not even prescribing the full 'solution', but it's a sketch of the pros/cons of a couple approaches. This can help me remind myself later of why a particular option was chosen, even if it turns out to be bad. I can't say if anyone else who looks at the code ever also reads what I've written - it seems that generally they don't (even though I announce it and it's in the commit activity stream and PRs).
- ansq 7y ago> "for some writing code itself is an act that clarifies the still-murky concepts and helps to produce a good writeup." This is my philosophy after ~2 years of working on distributed systems. I got sick of vague design discussions where everyone has a 5 minute memory. I am much happier to sit at my desk and figure it out by writing code, then produce a design doc once I have a solid prototype working. It feels more honest and real. At the same time, I wonder if I'm missing out on a different way of doing things.
- to11mtm 7y agoFor me, it depends on the problem being solved. If the problem is in a space that we know what the solution 'should' look like, getting as much of that down in the most abstract sense is something I like to do. However that design is only a -proposed- solution, and of course subject to all sorts of changes. But where things are murky in a design, yeah, sometimes the easiest thing to do is code it out. In either case, (up to date) diagrams of data flows are one's friend in any distributed system.
- cheez 7y agoAs long as when you're writing code, you're solving only immediate problems in a lightweight way, this is the way to go. Most people, of course, overengineer. I remember being on a project where a guy wrote 5000 lines of code to put two columns in a specific browser.
- macromagnon 7y agoThis reminds me of TDD arguments. If I'm working within a system I like to code the minimum golden path, add a tests that passes, then add more checks or a new test and go back to the code, etc. Usually the constraints of the system point the way to an obvious skeletal implementation and you can learn as you go along. On a greenfield project it is especially valuable to have discussions beforehand if people have done something similar before but talking about code at a high level tends to become nebulous rather quickly.
- war1025 7y agoI think the philosophy behind TDD is really valuable in the sense of "start with a goal in mind", but I find that I get better results with running and iterating than going to the effort of writing tests all the way out. Probably just a mismatch of our testing tools vs the types of things I need to develop usually
- itsmemattchung 7y agoI don't think that writing software is a linear process, as much as us software developers would like it to be. Broadly speaking, there tends to be two approaches. First is documenting and designing. The second is prototyping some code. I actually sit somewhere right in the middle: prototype and use that prototype to inform my document — then I switch back and forth between the two. Really, for me, it's a circular process — not linear.
- a_c 7y agoWriting proper/decent software specification is what, IMO, missing from most modern day software development. The idea is that, someone knowing deep enough what AND how to build, penning down vague ideas as concrete as needed, and hand off the rest to the team. In fact, every engineer need a plan, either for themselves or for the team, either implicit or explicit. Having an explicit plan for a project's development is what I find resulting in a coherent and high fidelity product. Agile software development is used by many as a disguise of not knowing what to build. Countless hours have been wasted on "iteration". I'm not saying agile is bad. Just that many are adopting agile without knowing why they should