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. Keeping track. Something I do with professional projects

Keeping track. Something I do with professional projects

Scheduled Pinned Locked Moved The Lounge
hardwaretutorial
34 Posts 24 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.
  • H honey the codewitch

    I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

    To err is human. Fortune favors the monsters.

    R Offline
    R Offline
    Ron Nicholson
    wrote on last edited by
    #2

    I've recently started doing something similar. I also add any repos that I need to complete the project/ticket. I'm working in Windows 10 and really miss using grep to parse the files. It can still be done and I probably need to learn some regex to make PowerShell more effective. Do you format your files in any particular way? Do you use different files for different notes, like each day gets it own file or do you just stick it all in one? I'm still working on my process at this point, but it seems to work reasonably well for me, so far. Ron

    Jack of all trades, master of none, though often times better than master of one.

    H 1 Reply Last reply
    0
    • H honey the codewitch

      I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

      To err is human. Fortune favors the monsters.

      OriginalGriffO Offline
      OriginalGriffO Offline
      OriginalGriff
      wrote on last edited by
      #3

      I do similar stuff, though I tend to use a spreadsheet. It started decades ago as a "day book" where you make notes of what has happened / been tried / resulted through the day, including phone calls and conversations. Handy when the boss conveniently "forgets" what we discussed a couple of weeks ago. :-D

      "I have no idea what I did, but I'm taking full credit for it." - ThisOldTony "Common sense is so rare these days, it should be classified as a super power" - Random T-shirt AntiTwitter: @DalekDave is now a follower!

      "I have no idea what I did, but I'm taking full credit for it." - ThisOldTony
      "Common sense is so rare these days, it should be classified as a super power" - Random T-shirt

      1 Reply Last reply
      0
      • R Ron Nicholson

        I've recently started doing something similar. I also add any repos that I need to complete the project/ticket. I'm working in Windows 10 and really miss using grep to parse the files. It can still be done and I probably need to learn some regex to make PowerShell more effective. Do you format your files in any particular way? Do you use different files for different notes, like each day gets it own file or do you just stick it all in one? I'm still working on my process at this point, but it seems to work reasonably well for me, so far. Ron

        Jack of all trades, master of none, though often times better than master of one.

        H Offline
        H Offline
        honey the codewitch
        wrote on last edited by
        #4

        I probably should format them, but I'm very "loose" in how I work unless forced to be otherwise. I tend to like to work quickly, and with as little red tape and furbling as possible, so my notes are almost shorthand, like I'd take in school. I don't really write it for others is the reason, although others do tend to find value in them, and sometimes i'll go back later and flesh out some of the important stuff. I'd say if you need to be organized, maybe do what Griff suggested and use a spreadsheet or similar. Otherwise I'd suggest that workflow is king. The tighter it is, the less it costs to write code, so don't overdo it with structure you don't need. Me, I just use VS code and a text file, or if i need a bit more organization I'll use markdown. I'd say just enough that you can hunt through it later, with "hunt" sort of depending on the project scope - for large projects i tend to keep like a book format with "chapters" (or even whole files) on particular topics but that's as far as I go typically.

        To err is human. Fortune favors the monsters.

        1 Reply Last reply
        0
        • H honey the codewitch

          I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

          To err is human. Fortune favors the monsters.

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

          DevOps provides our team this ability. One single user story or bug is tied to all code reviews, work tasks, and deployments, testing, etc. Notes are usually added to the user story or bug. We also have Wikis as part of our individual repos so that developers can add/edit/view dev related resources regarding that particular repo code, etc.

          H J G 3 Replies Last reply
          0
          • S Slacker007

            DevOps provides our team this ability. One single user story or bug is tied to all code reviews, work tasks, and deployments, testing, etc. Notes are usually added to the user story or bug. We also have Wikis as part of our individual repos so that developers can add/edit/view dev related resources regarding that particular repo code, etc.

            H Offline
            H Offline
            honey the codewitch
            wrote on last edited by
            #6

            Must be nice. I work from home with minimal development infrastructure. It works for me, but it does mean being flexible and willing to work with rough tools.

            To err is human. Fortune favors the monsters.

            S 1 Reply Last reply
            0
            • H honey the codewitch

              I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

              To err is human. Fortune favors the monsters.

              D Offline
              D Offline
              dandy72
              wrote on last edited by
              #7

              I started keeping my own daily, chronological notes (new day = new page) in OneNote; my oldest entry goes back to 2010. This was before they had an online version, or at least, an online version that worked reliably enough to use. Otherwise this is where I'd be keeping them. There *are* good tidbits that we share in a company notebook (online version of OneNote), but my own notes tend to build upon the previous day's work, so without the greater context they wouldn't be particularly useful for anyone but myself. It's been useful, despite the fact that the search feature could use a lot of polish.

              P 1 Reply Last reply
              0
              • H honey the codewitch

                I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

                To err is human. Fortune favors the monsters.

                R Offline
                R Offline
                Ron Anders
                wrote on last edited by
                #8

                Me too.

                1 Reply Last reply
                0
                • H honey the codewitch

                  I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

                  To err is human. Fortune favors the monsters.

                  Mike HankeyM Offline
                  Mike HankeyM Offline
                  Mike Hankey
                  wrote on last edited by
                  #9

                  I tried keeping notes on various projects but can never seem to keep it up-to-date. So I store the information in a safe part of my brain where I won't forget..........?

                  PartsBin an Electronics Part Organizer - An updated version available! JaxCoder.com

                  H 1 Reply Last reply
                  0
                  • Mike HankeyM Mike Hankey

                    I tried keeping notes on various projects but can never seem to keep it up-to-date. So I store the information in a safe part of my brain where I won't forget..........?

                    PartsBin an Electronics Part Organizer - An updated version available! JaxCoder.com

                    H Offline
                    H Offline
                    honey the codewitch
                    wrote on last edited by
                    #10

                    Good luck!

                    To err is human. Fortune favors the monsters.

                    1 Reply Last reply
                    0
                    • H honey the codewitch

                      I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

                      To err is human. Fortune favors the monsters.

                      K Offline
                      K Offline
                      kmoorevs
                      wrote on last edited by
                      #11

                      On the development side, most project folders will have a notes folder. For an import, (such as the one-off I am working on now) this folder has the original customer files, a document that describes the source(s) and methods for creating those files, and a change log. On the customer side, besides our hand-rolled CMS for notes, I also keep dated folders (YYYY-MM-DD) on an external data drive for keeping date related stuff like databases, scripts, or import files.

                      "Go forth into the source" - Neal Morse "Hope is contagious"

                      H 1 Reply Last reply
                      0
                      • K kmoorevs

                        On the development side, most project folders will have a notes folder. For an import, (such as the one-off I am working on now) this folder has the original customer files, a document that describes the source(s) and methods for creating those files, and a change log. On the customer side, besides our hand-rolled CMS for notes, I also keep dated folders (YYYY-MM-DD) on an external data drive for keeping date related stuff like databases, scripts, or import files.

                        "Go forth into the source" - Neal Morse "Hope is contagious"

                        H Offline
                        H Offline
                        honey the codewitch
                        wrote on last edited by
                        #12

                        kmoorevs wrote:

                        On the development side, most project folders will have a notes folder. For an import, (such as the one-off I am working on now) this folder has the original customer files, a document that describes the source(s) and methods for creating those files, and a change log.

                        I basically do the same thing. My notes folder doesn't just contain my notes, but relevant associated documents and such, just so it can all be in a known place and in source control. I use "notes" as a sort of standard name (all my projects that need one have the same name for that folder) even if it is a bit of a misnomer sometimes because it encompasses more than that.

                        To err is human. Fortune favors the monsters.

                        1 Reply Last reply
                        0
                        • H honey the codewitch

                          I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

                          To err is human. Fortune favors the monsters.

                          J Offline
                          J Offline
                          jmaida
                          wrote on last edited by
                          #13

                          You are doing what many professionals do, i.e. Lawyers, doctors, engineers, etc. do whatever style format etc that works for you. I try to summarize from time to time for clarity of purpose and the look at next stages. It is also important to note that they are not just for you.

                          "A little time, a little trouble, your better day" Badfinger

                          1 Reply Last reply
                          0
                          • H honey the codewitch

                            I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

                            To err is human. Fortune favors the monsters.

                            R Offline
                            R Offline
                            Roger Wright
                            wrote on last edited by
                            #14

                            Heck, at my age I keep notes to remind me which room I last visited.

                            Will Rogers never met me.

                            0 1 Reply Last reply
                            0
                            • R Roger Wright

                              Heck, at my age I keep notes to remind me which room I last visited.

                              Will Rogers never met me.

                              0 Offline
                              0 Offline
                              0x01AA
                              wrote on last edited by
                              #15

                              ... and one (?) general note which lists where are the notes I noted :laugh:

                              D 1 Reply Last reply
                              0
                              • H honey the codewitch

                                Must be nice. I work from home with minimal development infrastructure. It works for me, but it does mean being flexible and willing to work with rough tools.

                                To err is human. Fortune favors the monsters.

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

                                Sorry, I forgot. I get used to my company paying for everything because they have the budget. I imagine there are less expensive/enterprisey tools out there.

                                1 Reply Last reply
                                0
                                • S Slacker007

                                  DevOps provides our team this ability. One single user story or bug is tied to all code reviews, work tasks, and deployments, testing, etc. Notes are usually added to the user story or bug. We also have Wikis as part of our individual repos so that developers can add/edit/view dev related resources regarding that particular repo code, etc.

                                  J Offline
                                  J Offline
                                  jschell
                                  wrote on last edited by
                                  #17

                                  Slacker007 wrote:

                                  One single user story or bug is tied to all code reviews

                                  Just noting that that is somewhat of a short term solution. Saying that because I have seen the same thing. What happens is that 5 years or perhaps 10 years from now they will change systems. And now that story/bug is gone. Or they might decide to re-org the original ticketing system. So now there is a location for the 'new' story/bugs and different one for the 'old' ones.

                                  1 Reply Last reply
                                  0
                                  • 0 0x01AA

                                    ... and one (?) general note which lists where are the notes I noted :laugh:

                                    D Offline
                                    D Offline
                                    David ONeil
                                    wrote on last edited by
                                    #18

                                    (and don't forget the string on your finger)

                                    Our Forgotten Astronomy | Object Oriented Programming with C++ | Wordle solver

                                    1 Reply Last reply
                                    0
                                    • S Slacker007

                                      DevOps provides our team this ability. One single user story or bug is tied to all code reviews, work tasks, and deployments, testing, etc. Notes are usually added to the user story or bug. We also have Wikis as part of our individual repos so that developers can add/edit/view dev related resources regarding that particular repo code, etc.

                                      G Offline
                                      G Offline
                                      Gaston Verelst
                                      wrote on last edited by
                                      #19

                                      That's how I work as well. Usually working in a team, I first describe in the wiki what I'm going to implement and how. This then serves as a "discussion board" and as later documentation.

                                      Check out my blog at http://msdev.pro/

                                      1 Reply Last reply
                                      0
                                      • H honey the codewitch

                                        I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

                                        To err is human. Fortune favors the monsters.

                                        D Offline
                                        D Offline
                                        den2k88
                                        wrote on last edited by
                                        #20

                                        Same, I'm a bit more messy so I keep a handful of plain text diaries and all the e-mails pertinent to the requirements / technical part of the stuff plus a transcript of the chats or phone calls.

                                        GCS/GE d--(d) s-/+ a C+++ U+++ P-- L+@ E-- W+++ N+ o+ K- w+++ O? M-- V? PS+ PE Y+ PGP t+ 5? X R+++ tv-- b+(+++) DI+++ D++ G e++ h--- r+++ y+++*      Weapons extension: ma- k++ F+2 X

                                        1 Reply Last reply
                                        0
                                        • H honey the codewitch

                                          I typically keep a /notes folder under my professional work such that I can write down pertinent things that come up as the project progresses such as technical points from a phone conversation relevant to the completing the software project (what hardware driver ICs are being used for example) It does a few things. It keeps me organized, and keeps my notes safely in source control. It also keeps things handy for other people I work with to go through. It's very simple to do, and it has proven invaluable to me time and again.

                                          To err is human. Fortune favors the monsters.

                                          D Offline
                                          D Offline
                                          DerekT P
                                          wrote on last edited by
                                          #21

                                          Absolutely. Each client has their own folder, each project has its own subfolder. In there is an /admin folder which contains invoice PDFs, contracts, a "WIP" document so I know what I'm actually working on, and a notes.txt file. I open that up in Notepad and hit F5 (to date/timestamp the entry) then make a brief note of a meeting actions, personnel changes, strategic stuff they client discusses etc. Periodically I will clear out defunct / superseded stuff. It's in Notepad so I can access it really fast, and F5 is so useful. For support stuff (which is about all I do these days) I also have a tasks.txt file; again F5 timestamped and a very quick summary of time spent and task undertaken. That gets transcribed into an invoice at month-end. I should really do it direct into Excel (which I use for invoicing) but have a single Excel file for all the invoice spreadsheets for everyone, and with ~ 1000 invoices (each is a separate sheet) it's taking too long to open! :laugh:

                                          Telegraph marker posts ... nothing to do with IT Phasmid email discussion group ... also nothing to do with IT Beekeeping and honey site ... still nothing to do with IT

                                          H 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