IEEE1471, Architecture, but how to document design?
-
Dear reader, I have a question on design-documentation. Past time I have spent a lot of time to read about documentation of SW-Architecture ( ieee 1471, sei-book-views and beyond, and Software-systems architecture from Rosanski). I'm fit now with creation of architecture-documentation :) But suddenly there came into my mind: But how to document design?? Face with so many "architectural" opportunities it see there is no guidance at all for documenting SW-design. What's that. Seems, I miss the forest for the trees !? Can you give me some hints?
-
Dear reader, I have a question on design-documentation. Past time I have spent a lot of time to read about documentation of SW-Architecture ( ieee 1471, sei-book-views and beyond, and Software-systems architecture from Rosanski). I'm fit now with creation of architecture-documentation :) But suddenly there came into my mind: But how to document design?? Face with so many "architectural" opportunities it see there is no guidance at all for documenting SW-design. What's that. Seems, I miss the forest for the trees !? Can you give me some hints?
Not sure why someone voted you a 1, so here's a 5 to compensate. I'm not a big software architecture guru or anything, but I've always used a combination of various diagrams showing how things are related, structures, etc. There's probably a formal name for that, but I don't know what it might be.
CQ de W5ALT
Walt Fair, Jr., P. E. Comport Computing Specializing in Technical Engineering Software
-
Not sure why someone voted you a 1, so here's a 5 to compensate. I'm not a big software architecture guru or anything, but I've always used a combination of various diagrams showing how things are related, structures, etc. There's probably a formal name for that, but I don't know what it might be.
CQ de W5ALT
Walt Fair, Jr., P. E. Comport Computing Specializing in Technical Engineering Software
Walt Fair, Jr. wrote:
I'm not a big software architecture guru or anything, but I've always used a combination of various diagrams showing how things are related, structures, etc. There's probably a formal name for that, but I don't know what it might be.
Bloody Uni students, all theory and no practical knowledge.
Michael Martin Australia "I controlled my laughter and simple said "No,I am very busy,so I can't write any code for you". The moment they heard this all the smiling face turned into a sad looking face and one of them farted. So I had to leave the place as soon as possible." - Mr.Prakash One Fine Saturday. 24/04/2004
-
Walt Fair, Jr. wrote:
I'm not a big software architecture guru or anything, but I've always used a combination of various diagrams showing how things are related, structures, etc. There's probably a formal name for that, but I don't know what it might be.
Bloody Uni students, all theory and no practical knowledge.
Michael Martin Australia "I controlled my laughter and simple said "No,I am very busy,so I can't write any code for you". The moment they heard this all the smiling face turned into a sad looking face and one of them farted. So I had to leave the place as soon as possible." - Mr.Prakash One Fine Saturday. 24/04/2004
:laugh: :-D ;) :laugh: ;P
CQ de W5ALT
Walt Fair, Jr., P. E. Comport Computing Specializing in Technical Engineering Software
-
Dear reader, I have a question on design-documentation. Past time I have spent a lot of time to read about documentation of SW-Architecture ( ieee 1471, sei-book-views and beyond, and Software-systems architecture from Rosanski). I'm fit now with creation of architecture-documentation :) But suddenly there came into my mind: But how to document design?? Face with so many "architectural" opportunities it see there is no guidance at all for documenting SW-design. What's that. Seems, I miss the forest for the trees !? Can you give me some hints?
Hi Frygreen, There is an "algorithm" forum here on CodeProject, and while it doesn't get a lot of traffic now, it might be a place for you to post some questions. imho the best way to figure out how to document design is to ... start designing ... and start documenting ... and let the process evolve with, hopefully, you being able to see more clearly, with each iteration, what's of value, and what's non-essential. When you say "design," that could mean many things: are you speaking of modern GUI/UX design where asynchronous events can be triggered by the user at any moment ? Web design where all kinds of incoming data streams are being fed into the UI ? Or, perhaps you speak of that rare breed who often style themselves "software architects" who think in UML diagrams, and think the "Gang of Four" are "SuperHeroes," and leave coding for "mere mortals" ? :) Perhaps try to narrow what you mean by "design" down a bit. And, what better way to study design than to try to formally analyze the tools you use every day in terms of how they function, and what is enabling, and what is ridiculous. My nomination for the most ridiculous feature in Windows (including 7) is the slider put on the View menu in Windows Explorer in the drop-down menu: that's a number-one troglodyte in my little private chamber of curiosities. good luck, and by all means do ignore the rude louts here on the Lounge who regularly get their jollies by insulting newcomers. best, Bill
"Is it a fact - or have I dreamt it - that, by means of electricity, the world of matter has become a great nerve, vibrating thousands of miles in a breathless point of time? Rather, the round globe is a vast head, a brain, instinct with intelligence!" - Nathanial Hawthorne, House of the Seven Gables
-
:laugh: :-D ;) :laugh: ;P
CQ de W5ALT
Walt Fair, Jr., P. E. Comport Computing Specializing in Technical Engineering Software
Seems a couple of twats couldn't see the humour you and I did.
Michael Martin Australia "I controlled my laughter and simple said "No,I am very busy,so I can't write any code for you". The moment they heard this all the smiling face turned into a sad looking face and one of them farted. So I had to leave the place as soon as possible." - Mr.Prakash One Fine Saturday. 24/04/2004
-
Seems a couple of twats couldn't see the humour you and I did.
Michael Martin Australia "I controlled my laughter and simple said "No,I am very busy,so I can't write any code for you". The moment they heard this all the smiling face turned into a sad looking face and one of them farted. So I had to leave the place as soon as possible." - Mr.Prakash One Fine Saturday. 24/04/2004
Yeah. I guess they don't understand that I'm a Uni student with 40 years of practical experience and I gave a totally practical answer with no knowledge of the theory. Well, I gave you a 5, for whatever it was worth.
CQ de W5ALT
Walt Fair, Jr., P. E. Comport Computing Specializing in Technical Engineering Software
-
Hi Frygreen, There is an "algorithm" forum here on CodeProject, and while it doesn't get a lot of traffic now, it might be a place for you to post some questions. imho the best way to figure out how to document design is to ... start designing ... and start documenting ... and let the process evolve with, hopefully, you being able to see more clearly, with each iteration, what's of value, and what's non-essential. When you say "design," that could mean many things: are you speaking of modern GUI/UX design where asynchronous events can be triggered by the user at any moment ? Web design where all kinds of incoming data streams are being fed into the UI ? Or, perhaps you speak of that rare breed who often style themselves "software architects" who think in UML diagrams, and think the "Gang of Four" are "SuperHeroes," and leave coding for "mere mortals" ? :) Perhaps try to narrow what you mean by "design" down a bit. And, what better way to study design than to try to formally analyze the tools you use every day in terms of how they function, and what is enabling, and what is ridiculous. My nomination for the most ridiculous feature in Windows (including 7) is the slider put on the View menu in Windows Explorer in the drop-down menu: that's a number-one troglodyte in my little private chamber of curiosities. good luck, and by all means do ignore the rude louts here on the Lounge who regularly get their jollies by insulting newcomers. best, Bill
"Is it a fact - or have I dreamt it - that, by means of electricity, the world of matter has become a great nerve, vibrating thousands of miles in a breathless point of time? Rather, the round globe is a vast head, a brain, instinct with intelligence!" - Nathanial Hawthorne, House of the Seven Gables
Hello BillWoodruff, with "design" I mean "low level architecture" or "non architectural design" or "detailed design" as it was named previously by non-purists. My type of application is mostly embedded and sometimes .net-based. And I talk about all the "hard-core-features" as threads, interrupts, component dependencies,... There seems to be millions of pages on how to write a perfrect architectural documentation. But how do I document my (one or two or three) more or less small classes within my own component. Is there no standard available? best Frygreen
-
Hello BillWoodruff, with "design" I mean "low level architecture" or "non architectural design" or "detailed design" as it was named previously by non-purists. My type of application is mostly embedded and sometimes .net-based. And I talk about all the "hard-core-features" as threads, interrupts, component dependencies,... There seems to be millions of pages on how to write a perfrect architectural documentation. But how do I document my (one or two or three) more or less small classes within my own component. Is there no standard available? best Frygreen
Hi Frygreen, imho the more you describe very specifically the type of projects and design you are interested in, the more likely you are to get responses from people with similar interests, and concerns. And, do some searching on CP for articles in your area of interests. For example, Luc Patyn[^], a CodeProject MVP, and, imho, "leading light" on CP has a background in embedded systems, in addition to the many other dimensions of his technical expertise. Unfortunately, psychic powers seem to be in short supply here, and, to mutilate an old proverb: "to catch a cheese, make a noise like a mouse." best, Bill
"Is it a fact - or have I dreamt it - that, by means of electricity, the world of matter has become a great nerve, vibrating thousands of miles in a breathless point of time? Rather, the round globe is a vast head, a brain, instinct with intelligence!" - Nathanial Hawthorne, House of the Seven Gables
-
Hi Frygreen, imho the more you describe very specifically the type of projects and design you are interested in, the more likely you are to get responses from people with similar interests, and concerns. And, do some searching on CP for articles in your area of interests. For example, Luc Patyn[^], a CodeProject MVP, and, imho, "leading light" on CP has a background in embedded systems, in addition to the many other dimensions of his technical expertise. Unfortunately, psychic powers seem to be in short supply here, and, to mutilate an old proverb: "to catch a cheese, make a noise like a mouse." best, Bill
"Is it a fact - or have I dreamt it - that, by means of electricity, the world of matter has become a great nerve, vibrating thousands of miles in a breathless point of time? Rather, the round globe is a vast head, a brain, instinct with intelligence!" - Nathanial Hawthorne, House of the Seven Gables
My topic is independent of embedded. How do all the .net - guys here "detailed-design-documentation"? I remember now after 20 years of SW-development, that I never have seen any line of text where it is writen how to structure a design-document. I have many books on how to structure architecture instead. regards