• Home
  • Apps
  • Gadgets
    • Gadgets for Kids
    • Store gadgets
    • Tablet Computers
    • Cheaper Gadgets
    • Apple
      • iPhone
      • iPhone 5
      • iPad2
  • Games
    • Game Consoles
    • Online Games
    • Angry Birds
    • Instagram
    • Pinterest
    • Twitter

Techie Kids

(and a not so techie mom)

  • About
  • Disclosure
  • Privacy Policy

How Important Is Program Documentation

December 4, 2011 by Marie Gizelle 2 Comments

How Important Is A Program's Documentation

Programmer: At last! I’m done with this program! Ready to deploy! Yeah!

 

Oops! I don’t want to be a “killjoy” for your celebration for finishing your program. I just want to remind you of this important thing – the program documentation.

In software development cycle, program documentation was there. And the experts didn’t put it there for no important reason at all. If I would be ask on how important is the documentation of the program, I’d say it’s as important as the program itself.

Honestly, making the newbies to understand this thing wasn’t that easy. The same thing that it became so hard to me before. Why? Because at first, we always think that we must be the only who can understand the program that we wrote. Then why should we document it? It’s not being selfish. But like writers, programs are our copyright.

But in real world, things are always different from school days. Even if you have a so much big pride for the code you’ve written, you must make a documentation for it.

In real world, you’re not about to make programs for your own benefit. The company paid you for your ability and for your code. And time will come that other people will read your work.

Based on experience, and most programmer knows that writing your own code is easier than trying to debug the work of others. Because programmers have different styles or techniques on solving different problems. And that’s where the importance of program’s documentation will show.

In a well-developed company, this could be 95% true that they already have a working system. Now, the question is why they still need to hire developers? There would be two reasons for this. First, they need a programmer to maintain their system. And the second reason is they need improvement for their current system. If that would be the situation, can you say to your boss that you’ll write your own program for their system from the scratch? I guess, that would be so impossible unless they want to switch from a desktop-based system to a web-based one.

That’s why we must not take the documentation of a program for granted. And besides, this could be a help for you if you forgot something. We can’t trust our memory at all times, specially on emergency cases. It’s always better to be ready.

I hope that this article make some sense. That’s all for now.

Class Dismiss!

Do you like this article? Share it with your friends, post it on your wall, tweet about it.

image source: http://www.samsvb.co.uk/index.php?page=lesson&les=Lesson%2014

Tweet
Share
Share
Pin
0 Shares

You might also enjoy...

Programming Best PracticesProgramming Best Practices
What’s Common On Most Programmers?What's Common On Most Programmers?
The Pessimist Inside Every Good ProgrammerThe Pessimist Inside Every Good Programmer

Filed Under: Programming

Previous Post Tamagotchi turns half my age ^_^
Next Post 4 Geeky Wedding Gadgets

Comments

  1. Aj Banda says

    December 5, 2011 at 11:02 am

    Documentation is a MUST on all project… But I do confess that I don’t write one :p

    Creating a Technical documentation is twice as hard as coding your program. But this will surely save your ass after a few days of not looking on your code. :p

    Reply
    • Kris Edison says

      December 6, 2011 at 7:55 am

      a must…but like what most are doing, after the coding and it runs, documentation is out of our mind. 🙂

      Reply

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

WELCOME

WELCOME

We are techie kids.

FOLLOW ME

  • Instagram
  • Pinterest
  • Twitter

CATEGORIES

  • Activities
  • Angry Birds
  • Apple
  • Apps
  • Art
  • Bicycles
  • Blog
  • Blogging
  • Boating
  • Branding
  • Business Ventures
  • Camera accesories
  • Cameras
  • Canon
  • Careers
  • Cars
  • Certifications
  • Cheaper Gadgets
  • ChildCare
  • Computers
  • Crafting
  • DIYs
  • Domain Names
  • F1
  • Facebook
  • Family Fun
  • Family Time
  • Featured
  • Final Fantasy
  • Fishing
  • Football
  • Gadgets
  • Gadgets for Kids
  • Game Consoles
  • Game Rooms
  • Games
  • Geeky Weddings
  • Gift List
  • Giveaways
  • Gizmo
  • Google
  • Google Doodle
  • Green Conscious
  • Indoor Playground
  • Innovations
  • Innovators
  • Internet Giants
  • Introduction
  • iPad2
  • iPhone
  • iPhone
  • iPhone 5
  • Kids and Video Games
  • Kids in Doodles
  • Little Big Planet 2
  • Macbook
  • Macbook accessories
  • Mind games
  • Movie Trinkets
  • Movies
  • Museum Visits
  • Online Games
  • Online Presence
  • Online Shopping
  • Outdoor
  • Park Play
  • Phones
  • Photoshoots
  • Pixar
  • Playmobil
  • Playstation Games
  • Programming
  • RC Helicopters
  • Role playing games
  • Science
  • SEO Related
  • Silicon Valley
  • Slider Puzzles
  • Smartphones
  • Software
  • Sports
  • Steve Jobs
  • Stickers
  • Stock Photography
  • Store gadgets
  • Tablet Computers
  • Tennis
  • The Web
  • Toy shops
  • Toy Stories
  • Toy story
  • Tuesday Couch Potato
  • Uncategorized
  • Video Games
  • Virtual pets
  • Weddings
  • Wii
  • Winter Fun

GET UPDATES

Leave me your email to receive new entries, tips, and specially offers only for you! . Don´t miss any update!

LATEST POSTS

Raising Business-Minded Kids, 4 Best Points

Raising Business-Minded Kids, 4 Best Tips

7 Best Remote Control Toys For Techie Kids

Fun Park Visits With The Kids All 4 Seasons

Fun Park Visits With The Kids All 4 Seasons

Top 5 Techie Gifts for your Loved Ones

Top 5 Awesome Techie Gifts for your Loved Ones and More

techiekidsinfo

Summer may be over, but Saturdays and Sundays and Summer may be over, but Saturdays and Sundays and free times on weekdays are not. Are you running out of ideas of things to do with the kids? 

Head over to https://techiekids.info/diy-projects-to-do-with-the-kids for some tips on things kids might enjoy doing with you. 💕

#TechieKids #Thingstodo #KidsProjects #Activitiesforkids #FunStuff #Kidstuff
Ice cream break. #NotSoSummer #TechieKids #IceCre Ice cream break. #NotSoSummer

#TechieKids #IceCream #Kids
Vienna is our playground. #Playground #Play #Tech Vienna is our playground.

#Playground #Play #Techiekids
Taking a break from so much walking. #TechieKids Taking a break from so much walking. 

#TechieKids #GadgetKids #ExploringVienna #ViennaNationalLibrary
Hi 👋🏻 #TechieKids #Kids Hi 👋🏻

#TechieKids #Kids
Walking on ropes is fairly easy! 😉 #RopeWalk#T Walking on ropes is fairly easy! 😉

#RopeWalk#TechieKids #summer #WalkingOnRope #Adventure #Kids
Umbrella mine!!! #Ellaellaella #TechieKids #Umbre Umbrella mine!!! #Ellaellaella

#TechieKids #Umbrella #Sundays #SemiFormal
Swing away! #TechieKids #Swing #Balance #Playgrou Swing away!

#TechieKids #Swing #Balance #Playground
Follow on Instagram
This error message is only visible to WordPress admins
There has been a problem with your Instagram Feed.

GET UPDATES

Leave me your email to receive new entries, tips, and specially offers only for you! . Don´t miss any update!

  • Instagram
  • Pinterest
  • Twitter

COPYRIGHT © 2019. Emma Theme by Lovely Confetti · DMCA.com Protection Status