Author Topic: *** README ***  (Read 2842 times)

0 Members and 1 Guest are viewing this topic.

adarqui

  • Administrator
  • Hero Member
  • *****
  • Posts: 30104
  • who run it.
  • Respect: +7286
    • View Profile
    • Email
*** README ***
« on: January 05, 2013, 09:54:45 am »
0
This subforum is dedicated entirely to projects we may be working on. This area is meant to help make more efficient the process of documenting ones code, from design throughout the life cycle of the project. I myself have found that inefficient documentation processes eventually result in a distraction away from the intended design goals/focus of the project. Proper documentation also helps others read & fork your code, as well as making it easier for *you* to come back to it at later dates and resume development of the project.

vag

  • Hero Member
  • *****
  • Posts: 5001
  • Respect: +2717
    • View Profile
Re: *** README ***
« Reply #1 on: January 05, 2013, 11:31:16 am »
0
Great idea.
I have found that public-documenting your project helps TONS in better architecture. Even if you pre-design it and you are very good at that too, when you are public-documenting your mind changes state and that does the trick. You are no longer taking a few crucial notes for yourself, you think 'explain it better', you maximize the simplicity and directness of tasks/objects and that makes the design more efficient in most cases.
Looking forward to see some badass architectures in here  :headbang:
woot

adarqui

  • Administrator
  • Hero Member
  • *****
  • Posts: 30104
  • who run it.
  • Respect: +7286
    • View Profile
    • Email
Re: *** README ***
« Reply #2 on: January 05, 2013, 12:51:56 pm »
0
Great idea.
I have found that public-documenting your project helps TONS in better architecture. Even if you pre-design it and you are very good at that too, when you are public-documenting your mind changes state and that does the trick. You are no longer taking a few crucial notes for yourself, you think 'explain it better', you maximize the simplicity and directness of tasks/objects and that makes the design more efficient in most cases.
Looking forward to see some badass architectures in here  :headbang:

100%.

As soon as I made this subforum, my note taking process became "Professional" instead of simply jotting down notes in a file. I might be able to navigate it, but others wouldn't. They would think it's a mess.

A good example is my darqbot project... I pretty much know that thing inside and out. If ANYONE tried to mod/fork that project, they would be completely lost. It's modular, well designed, and pretty clean.... But, it has zero documentation and has hardly any comments.

So from now on, I personally am going to focus on:

 - In depth documentation of the api/flow of my projects & post this publically
 - Once my projects reach version 1, turn post them to github then work out of git from then on
 - Try and focus on building projects that people can use, not just for my own personal enjoyment :D

I have another sick thread coming in the NERD THE F OUT FORUM, you'll luv it.

peace vag!