Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • World
  • Users
  • Groups
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
Code Project
  1. Home
  2. The Lounge
  3. Documentation: How thorough are you with it?

Documentation: How thorough are you with it?

Scheduled Pinned Locked Moved The Lounge
question
31 Posts 17 Posters 0 Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • S Slacker007

    Not code documentation so much but the documentation involved with requests/mods/enhancements. Stuff like who made the request, dates and times, reason for the change or mod, that kind of stuff. Documentation that you would use for audit purposes and for catching people in lies. I am glad that I archive my e-mails and keep files for EVERY project that I work on; it has saved my ass on numerous occasions. I have been in a back and forth, he said - she said, ordeal as of late, where a project manager has said that they notified us of some enhancements/changes that needed to be made and we show no documentation or proof that this meeting ever took place. Now, the powers that be want to know who dropped the ball.

    -- ** You don't hire a handyman to build a house, you hire a carpenter. ** Jack of all trades and master of none.

    N Offline
    N Offline
    NormDroid
    wrote on last edited by
    #19

    Never doc, like to live life in the fast lane.

    Software Kinetics - The home of good software

    1 Reply Last reply
    0
    • S Slacker007

      Ian Shlasko wrote:

      That's rare.

      Sarcasm? Can't tell. I have always worked in shops that have women on the teams. Some of the best developers I have worked with are women. My immediate boss is a woman and I have learned a lifetime of stuff from her.

      -- ** You don't hire a handyman to build a house, you hire a carpenter. ** Jack of all trades and master of none.

      I Offline
      I Offline
      Ian Shlasko
      wrote on last edited by
      #20

      Wow, really? My entire career, I've only worked with two female developers... Well, they were on the server team, while I was working on the client, but still... There were a couple women in QA too, but no other programmers.

      Proud to have finally moved to the A-Ark. Which one are you in?
      Author of the Guardians Saga (Sci-Fi/Fantasy novels)

      S 1 Reply Last reply
      0
      • I Ian Shlasko

        Wow, really? My entire career, I've only worked with two female developers... Well, they were on the server team, while I was working on the client, but still... There were a couple women in QA too, but no other programmers.

        Proud to have finally moved to the A-Ark. Which one are you in?
        Author of the Guardians Saga (Sci-Fi/Fantasy novels)

        S Offline
        S Offline
        Slacker007
        wrote on last edited by
        #21

        Ian Shlasko wrote:

        Wow, really?

        Yes. and some are very easy on the eyes as well. ;)

        -- ** You don't hire a handyman to build a house, you hire a carpenter. ** Jack of all trades and master of none.

        1 Reply Last reply
        0
        • S Slacker007

          Not code documentation so much but the documentation involved with requests/mods/enhancements. Stuff like who made the request, dates and times, reason for the change or mod, that kind of stuff. Documentation that you would use for audit purposes and for catching people in lies. I am glad that I archive my e-mails and keep files for EVERY project that I work on; it has saved my ass on numerous occasions. I have been in a back and forth, he said - she said, ordeal as of late, where a project manager has said that they notified us of some enhancements/changes that needed to be made and we show no documentation or proof that this meeting ever took place. Now, the powers that be want to know who dropped the ball.

          -- ** You don't hire a handyman to build a house, you hire a carpenter. ** Jack of all trades and master of none.

          F Offline
          F Offline
          fjdiewornncalwe
          wrote on last edited by
          #22

          That's what BA's are for.

          I wasn't, now I am, then I won't be anymore.

          1 Reply Last reply
          0
          • V V 0

            Actually that is a very good practice ! At least they focus on a solution instead of on the problem. :-D

            V.

            X Offline
            X Offline
            Xiangyang Liu
            wrote on last edited by
            #23

            It is also polical correctness. Basically there is no reward for high quality work and no punishment for screwing up, because nobody should be "pointing fingers" no matter what.

            My Younger Son & His "PET"

            B 1 Reply Last reply
            0
            • S Slacker007

              Not code documentation so much but the documentation involved with requests/mods/enhancements. Stuff like who made the request, dates and times, reason for the change or mod, that kind of stuff. Documentation that you would use for audit purposes and for catching people in lies. I am glad that I archive my e-mails and keep files for EVERY project that I work on; it has saved my ass on numerous occasions. I have been in a back and forth, he said - she said, ordeal as of late, where a project manager has said that they notified us of some enhancements/changes that needed to be made and we show no documentation or proof that this meeting ever took place. Now, the powers that be want to know who dropped the ball.

              -- ** You don't hire a handyman to build a house, you hire a carpenter. ** Jack of all trades and master of none.

              I Offline
              I Offline
              ian dennis 0
              wrote on last edited by
              #24

              FRD before coding starts (I call it a Solutions Requirement Document, although it is heavy on Function and light on Form), possibly augmented by Use Cases. Solutions Control Document after the project is implemented - describes the platform, deployment type, etc. Additonally, we are bound by Sarbanes-Oxley (SOX) auditing, and every change/implementation to a production server requires a Change Request to be created. This typically includes tasks for: . Request to Proceed (completed by customer) . Testing Completed (completed by customer) . Deployment to Production (documented by IT, approved by Change Management) . Post-Release Review (completed by customer)

              1 Reply Last reply
              0
              • S Slacker007

                Not code documentation so much but the documentation involved with requests/mods/enhancements. Stuff like who made the request, dates and times, reason for the change or mod, that kind of stuff. Documentation that you would use for audit purposes and for catching people in lies. I am glad that I archive my e-mails and keep files for EVERY project that I work on; it has saved my ass on numerous occasions. I have been in a back and forth, he said - she said, ordeal as of late, where a project manager has said that they notified us of some enhancements/changes that needed to be made and we show no documentation or proof that this meeting ever took place. Now, the powers that be want to know who dropped the ball.

                -- ** You don't hire a handyman to build a house, you hire a carpenter. ** Jack of all trades and master of none.

                C Offline
                C Offline
                Caslen
                wrote on last edited by
                #25

                I haven't been on here for a while, does the kid sister rule no longer apply? I mean blatant use of the 'D' word - and in the subject line as well, I'm shocked!! ;)

                1 Reply Last reply
                0
                • H Henry Minute

                  Fortunately this no longer impinges on my life. I say fortunately because I was probably the worlds worst. Code documentation - immaculate. Any other form of documentation - abysmal. I would forever be in the situation of meeting 'fred' (who submitted a feature request a couple of days ago), in the lift or canteen, or wherever, and during the conversation we would agree some change to it. That remained in my head, it got done, but wouldn't be documented until the completion stage. Personally I blame him, he should have submitted a change to the change request.

                  Henry Minute Do not read medical books! You could die of a misprint. - Mark Twain Girl: (staring) "Why do you need an icy cucumber?" “I want to report a fraud. The government is lying to us all.” I wouldn't let CG touch my Abacus! When you're wrestling a gorilla, you don't stop when you're tired, you stop when the gorilla is.

                  P Offline
                  P Offline
                  PirateT7
                  wrote on last edited by
                  #26

                  Henry Minute wrote:

                  I would forever be in the situation of meeting 'fred' (who submitted a feature request a couple of days ago), in the lift or canteen, or wherever, and during the conversation we would agree some change to it. That remained in my head, it got done, but wouldn't be documented until the completion stage.

                  The difficulty, from the POV of proj mgrs, requirements writers, and others who work with developers, is that often the canteen-line conversation was stated as "is this possible," "how difficult would it be," or "how long would this take" and wasn't meant to actually be done. With that info, the non-dev has in mind conversations they need to have with the customer, then at some point the change would be put into a "real" request. Instead, *poof* the change has been made without anyone expecting it, and now there's much scrambling to be done. I'm not saying this is always the case, but I see it often enough that I try to be explicit - "I am NOT asking you to make a change, I'm just asking for information here." If you're having this sort of situation come up repeatedly in your org, perhaps a "do you actually want this change or are you just asking for information?" type question would help avoid it. Or not, depending on the personalities involved :| -S

                  P 1 Reply Last reply
                  0
                  • X Xiangyang Liu

                    It is also polical correctness. Basically there is no reward for high quality work and no punishment for screwing up, because nobody should be "pointing fingers" no matter what.

                    My Younger Son & His "PET"

                    B Offline
                    B Offline
                    BrainiacV
                    wrote on last edited by
                    #27

                    Off topic... In your sig. Is your younger son's name Calvin?

                    Psychosis at 10 Film at 11

                    1 Reply Last reply
                    0
                    • X Xiangyang Liu

                      Slacker007 wrote:

                      Now, the powers that be want to know who dropped the ball.

                      That's good. In my company, the power that be never want to know who dropped the ball. All they ever ask is who can fix it and how long will it take. By not asking, I think they assume it is your fault (your name is the de-fault value). :)

                      My Younger Son & His "PET"

                      P Offline
                      P Offline
                      patbob
                      wrote on last edited by
                      #28

                      "I think they assume it is your fault" It could also mean they really don't care. Or maybe they know that all finding out will accomplish is to create fodder for office politics and create a CYA work culture, both of which are counterproductive to making money.

                      patbob

                      1 Reply Last reply
                      0
                      • P PirateT7

                        Henry Minute wrote:

                        I would forever be in the situation of meeting 'fred' (who submitted a feature request a couple of days ago), in the lift or canteen, or wherever, and during the conversation we would agree some change to it. That remained in my head, it got done, but wouldn't be documented until the completion stage.

                        The difficulty, from the POV of proj mgrs, requirements writers, and others who work with developers, is that often the canteen-line conversation was stated as "is this possible," "how difficult would it be," or "how long would this take" and wasn't meant to actually be done. With that info, the non-dev has in mind conversations they need to have with the customer, then at some point the change would be put into a "real" request. Instead, *poof* the change has been made without anyone expecting it, and now there's much scrambling to be done. I'm not saying this is always the case, but I see it often enough that I try to be explicit - "I am NOT asking you to make a change, I'm just asking for information here." If you're having this sort of situation come up repeatedly in your org, perhaps a "do you actually want this change or are you just asking for information?" type question would help avoid it. Or not, depending on the personalities involved :| -S

                        P Offline
                        P Offline
                        patbob
                        wrote on last edited by
                        #29

                        "I am NOT asking you to make a change, I'm just asking for information here." As a developer asked those kinds of what if questions, I learned to ask the correllary question at the end of the conversation.. "so, do you want me to go ahead and make that change?". They should teach that to new developers in developer school :)

                        patbob

                        P 1 Reply Last reply
                        0
                        • S Slacker007

                          Not code documentation so much but the documentation involved with requests/mods/enhancements. Stuff like who made the request, dates and times, reason for the change or mod, that kind of stuff. Documentation that you would use for audit purposes and for catching people in lies. I am glad that I archive my e-mails and keep files for EVERY project that I work on; it has saved my ass on numerous occasions. I have been in a back and forth, he said - she said, ordeal as of late, where a project manager has said that they notified us of some enhancements/changes that needed to be made and we show no documentation or proof that this meeting ever took place. Now, the powers that be want to know who dropped the ball.

                          -- ** You don't hire a handyman to build a house, you hire a carpenter. ** Jack of all trades and master of none.

                          M Offline
                          M Offline
                          Marbry Hardin
                          wrote on last edited by
                          #30

                          That's a good point. I've almost gotten into an actual fight in a meeting with a business person that could contradict himself at the rate of about 3 times every 10 minutes. And swear up and down with a straight face that's not what he told you 5 minutes ago. During meetings or phone calls, take notes. Then write up an email afterward with what was agreed on and send it out to everyone involved to get "official" approval. "Here are my notes from the meeting. Could you confirm that this is what you would like us to do?" Or something to that effect. Make it explicit and complete, double check it for vague or misleading language. Even in long email strings it may be necessary toward the end to summarize into a more concise form what you've been hashing out and get a final approval on what is actually going to be done. You can be tossing around options, and it can get confusing about what you're actually going to do or not do. Especially when you have a client that waffles like IHOP. If you're billing time, it's hard for the client to argue against hours after changing their mind about what they agreed to in an email. And it can save you a lot of hassle and hair pulling down the road.

                          1 Reply Last reply
                          0
                          • P patbob

                            "I am NOT asking you to make a change, I'm just asking for information here." As a developer asked those kinds of what if questions, I learned to ask the correllary question at the end of the conversation.. "so, do you want me to go ahead and make that change?". They should teach that to new developers in developer school :)

                            patbob

                            P Offline
                            P Offline
                            PirateT7
                            wrote on last edited by
                            #31

                            Yea, that's a "accurate communication is both parties' responsibility" thing. It would be great if we all would do it (I'll admit that I don't always do it either). Otherwise one party or the other (or both) is making an assumption... and we all know what that does.

                            1 Reply Last reply
                            0
                            Reply
                            • Reply as topic
                            Log in to reply
                            • Oldest to Newest
                            • Newest to Oldest
                            • Most Votes


                            • Login

                            • Don't have an account? Register

                            • Login or register to search.
                            • First post
                              Last post
                            0
                            • Categories
                            • Recent
                            • Tags
                            • Popular
                            • World
                            • Users
                            • Groups