7 ms·
Except at the highest level of abstraction, my Lucidchart diagrams and Google docs never survive their first encounter with the compiler. There always turns out
by closeparen 9y ago
Except at the highest level of abstraction, my Lucidchart diagrams and Google docs never survive their first encounter with the compiler. There always turns out to be some fatal flaw that's obvious in an editor but totally escaped me in the word processor. My (limited) experience has been teaching me the opposite: dive in as quickly as I can and write some code to explore the problem space, then go think harder about a design after getting my feet wet.
- reitanqild 9y agoPeople are very different it seems. I enjoy both diagramming and early exploratory coding. I have real problems when one of my (really smart) colleagues wants to discuss some code we have neither written nor diagrammed yet. For her however that seems to be the natural way of doing it and when we started working together I had to point out that just didn't work for me. It seems to me that knowing and being aware and accepting of the different learning styles can solve a number of problems in teams.
- enraged_camel 9y ago>>There always turns out to be some fatal flaw that's obvious in an editor but totally escaped me in the word processor. This problem goes away once you gain some experience - both in writing specs and in programming. Think of it this way: do engineers build bridges without design documents and diagrams? No. So why are you writing software without them? If you aren't familiar with the problem domain, fine, do it the agile way. But once you gain experience there is no excuse to not thinking problems through in advance before trying to solve them.
- closeparen 9y agoIt's faster and more pleasant to write working code than to write prose descriptions of hypothetical code. Documents are cheaper to create and easier to change than bridges. Code is just another kind of document. I've a sneaking suspicion that bridge building would look more like software if we could drive over AutoCAD models. (Or that software would look more like bridge building if we were still compiling by hand). EDIT: I should add that I certainly do write and communicate documents about "what business problem does this even solve" and "what does it do" and "what are the major components and what are they responsible for" and "did you consider X alternative design" but planning down to the level of function signatures has usually turned out to be a waste of time.
- sbov 9y agoYeah, someone pointed this out to me once, and it is an interesting spin on the comparison of software engineering to other types of engineering. More succinctly: We don't build our "bridges", our compilers/interpreters do.
- jimmaswell 9y agoThe engineers don't build the things either, the construction workers do.
- closeparen 9y agoSure, but it’s the construction work that you don’t start until you have exhaustive documentation.
- syshum 9y ago>>Documents are cheaper to create and easier to change than bridges. Code is just another kind of document. That really depends on the type of code you are writting. Writing code going into a space craft, or Nuclear Power Plant, or Encryption code that can be relied on by people to protect their actual life, or code going into a medical device or.... you get the picture Yes if your writing code going into the next Pokemon time waste game sure you can be fast and lose, but to not presume all code is the same. In this instance, code is going into devices that historically do not get updated properly, I think that warrants taking a more "bridge building" approach and less "Code is just a document" approach
- closeparen 9y agoI think for that argument to work, you'd have to show that the word processing activity actually yields fewer errors in the resulting software. I guess what I'm saying here is that I've found writing prose beforehand to have low to zero ROI in terms of resulting software quality. I totally believe that writing math and actually proving things about your ideas would. The more important code is, the more I want to see it subjected to a realistic and comprehensive test suite, careful peer review, etc. Although you're right, I ultimately work on backend systems that can cause some downtime at worst, not industrial process control or crypto libraries. I also have the luxury of doing continuous delivery, incremental rollouts, feature flags, staging environments with shadow traffic, etc. so there are a lot of safeguards standing between a mistake and widespread impact.
- Kiro 9y ago> This problem goes away once you gain some experience As will the need for planning beforehand.
- legulere 9y agoCode is just a detailed specification. A better analogy is that you start with designing the nuts and bolts without knowing how the beige is supposed to look.
- d0mine 9y agoProgramming is the design. Building is performed by a compiler (free part). Also, flowcharts are less readable than most programming languages in non-trivial cases. Graphical programming languages are mostly useful as DSLs. Text is unbeatable in the general case.
- jl6 9y agoI once worked on a Finance project which had grand aspirations and decided it was going to Do Things Right by starting with extensive specifications. The developers insisted on all behaviour being specified and documented before they would start coding. Of course, a truly exacting specification is equivalent to code. So the users who had been tasked with describing the required functionality ended up inventing their own DSL and “coding” the entire system in Microsoft Word. Needless to say, they were the only ones who understood the spec. IT cried foul. Business cried “this is what you asked for!” Cue months of arguments over what constituted a proper spec, during which the users essentially taught themselves how to code. The software eventually ended up being written by transliterating the DSL into actual code. It worked, but remains to this day an unmaintainable mess.
- tomsmeding 9y ago> It worked Congratulations!
- bdamm 9y agoIndeed, usually these approaches are abandoned due to reaching a point where arguments over specifications consume years and nothing happens. The project is killed and everyone involved are reassigned elsewhere, hopefully having learned something, but usually there's no such evidence of learning.
- arekkas 9y agoThis is truly a great anecdote. I wish I could bookmark comments on HN, because I want to dig out this one when the time comes.
- squeeeeeeeeeee 9y ago> I wish I could bookmark comments on HN You see that "X hours ago" to the right of the username? Yeah, click that...
- 9y ago
- KGIII 9y agoI am not a programmer. I have done a lot of programming. Eventually, I was able to hire competent professionals. I have taken very few formal courses in programming and zero in what I'd call computer science. I programmed out of necessity. Computers were pretty useless if you didn't. So, take this with a grain of salt. I can't code without a diagram. I make a diagram and process the logic. I make lots of sub diagrams. I make notes and ask myself a lot of questions. I'll also ask other people, if I can. I can't do it. I can't program 'on the fly.' My attempts have resulted in horrible results, not even qualified to be called results. If I don't process the logic, pretty much from start to finish, I can't do it. I use a notation system that isn't even a real programming language and leave lots of room to cram more stuff in and make corrections. Most of this is past tense, I don't do much anymore. I'm retired and my efforts are just little automation tasks for my own needs. Anyhow, I figured I'd offer another perspective/opinion. I envy you if you can do it off the cuff. I've tried, I can't.
- Normal_gaussian 9y agoI have a CS degree and a few years professional programming I have coded on-the-fly and I have coded from diagram first approaches. on-the-fly works for me when there is an obvious data structure to work to, otherwise it takes a lot longer than planning it out because of all the edge cases
- throwme211345 9y agoData structures and ADTs are the key in general.
- nradov 9y agoI think it depends on thinking style and mental models. Personally I have "diagram blindness"; most diagrams look like visual noise. Usually I get better (fast, reliable, maintainable) results by just coding on the fly and then relentlessly refactoring as the optimal design gradually reveals itself.
- brodock 9y agoIf you consider the diagrams as a physical manifestation of abstractions that can eventually be converted into boolean logic, etc than it's the same thing. For many years I used to draw on paper a mix of non-standard diagrams with some pseudo-code to discuss slightly complex algorithm implementations with peers... the more coding experience you have, the less you need to do this and you usually make the connections just in your brains and start coding. So my tip here is if you want to learn how to do it on the fly you should start with small steps by reducing the amount of stuff you need to see in a paper before start coding. In the other hand it's perfectly normal and there is no problem in doing what you do.
- omginternets 9y agoIsn't this where formal specification languages like TLA+ are useful?
- rcxdude 9y agoThinking in state machines is not the same as design up front. Most languages lack a good way to describe state machines, but there are many libraries which do this and even produce the diagrams for you (which can be very helpful when trying to understand the code). I frequently write state machines in an incremental manner.
- jimmaswell 9y agoEnums (or named constants if you don't have enums) and switch statements (or if you don't have these, make a hashmap of state->method or something) are all you need. I'm not sure I get what you mean.
- tremon 9y agoOne of the primary features of state machines is that state transitions are well-defined. "Describing state machines", as the GP said, is typically done with tools like a reachability matrix or truth table. A looped switch statement will allow you to implement a state machine, but not describe it. In other words, how would you express in code: "state Z can only be entered through either state W or X, but not through state Y", or "state V must be followed by state W, but only after condition A"? Sure, you can write a switch statement. But half the rules of a state machine can only be implemented by omission (i.e. by not coding it, instead of hardcoding the requirements).