Beefy Boxes and Bandwidth Generously Provided by pair Networks
more useful options
 
PerlMonks  

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

talexb wrote (in Interview Counterattacks):

I started keeping a log book a few years back -- it was something my colleague Mike Stok did, and it's fantastic. Now when someone asks me something, I flip back in the book and read out the command I typed. That's way better than "Oh, I think I typed in ..". I can also pin-point, to day anyway, when I actually did something a few weeks or months back.

Paper log books have their uses, but myself I've gotten in the habit of using text files full of notes (and I adopted the convention of naming them all "notes-*", very useful when I want to search for them). As I'm working on a project, I add things to the notes-* file for the project (error messages, thoughts, commands I tried, snippets of code, solutions that worked). It helps somewhat that I tend to live inside of emacs: I may have a shell window and a notes-* file buffer open in the same emacs frame, so I can switch back and forth between the two of them. The notes-* file helps me focus even if I'm interrupted/bored/etc and if someone says "Hey, you know how to do this, you did this last month, right?", I much prefer being able to say "Let me check my notes" rather than "Last month! You expect me to remember what I did last month?!"

Further -- since I work in emacs -- I can save the shell buffer to a file (usually called "shell-*") and I always have a record of precisely what I did, even if I didn't think to add it to the notes file. There was one occasion where my supervisor asked me if I might have forgotten to do a COMMIT the day before, and I happened to have the SQL/PLUS session saved to a file, so I could prove that I hadn't forgotten.

The drawback to this, however, is that if someone accuses me of causing a problem by a stupid mistake, it's possible for me to verify that yes, indeed, I am the one who made that stupid mistake.

More about notes-* files practices, if any one cares: I type rows of equal signs (e.g. "===") to visually divide between topics; I often label things with uppercase tags (e.g. "TODO", "SUMMARY", etc) that are easy to find with case-sensitive searches later; and I've got a datestamp command bound to a few keystrokes, which I use nearly every time I start working...


In reply to Work practices: log books, notes files... by doom

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others avoiding work at the Monastery: (4)
As of 2021-06-12 22:42 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    What does the "s" stand for in "perls"? (Whence perls)












    Results (53 votes). Check out past polls.

    Notices?