|
Looks great!
I'd put a FAQ on each one though, and why not put all of this into a single article with [edit]href's at the top to easily get to the subsections in the article body[/edit]? Personally, I'd find that a lot easier to manage.
Marc
(the edit was to avoid confusion in the term "link")
Help! I'm an AI running around in someone's f*cked up universe simulator.
Sensitivity and ethnic diversity means celebrating difference, not hiding from it. - Christian Graus
Every line of code is a liability - Taka Muraoka
Microsoft deliberately adds arbitrary layers of complexity to make it difficult to deliver Windows features on non-Windows platforms--Microsoft's "Halloween files"
|
|
|
|
|
The reason I have it across 5 pages is for messages. There is only one message thread per article and it would be nice to have several on a project.
Jason Henderson latest CPP news
"If you are going through hell, keep going." - Winston Churchill
|
|
|
|
|
|
Paul Watson wrote:
So there will be a main Project page which links to the other articles related to the project?
That's the plan. 
Jason Henderson latest CPP news
"If you are going through hell, keep going." - Winston Churchill
|
|
|
|
|
Paul Watson wrote:
about your Harry Seldon Plan
No we are not going to plan out the resurgence of humanity and predict what its going to do. We need to build a foundation of some sort first.
And the maths! Only Colin would be interested.
Roger Allen
Sonork 100.10016
Were you different as a kid? Did you ever say "Ooohhh, shiny red" even once? - Paul Watson 11-February-2003
|
|
|
|
|
And the maths! Only Colin would be interested.
 Never a truer word was spoken!
Were you different as a kid? Did you ever say "Ooohhh, shiny red" even once? - Paul Watson 11-February-2003
LOL, I said that? Hell, better go search for it to remember. And I am honoured of course
Paul Watson
Bluegrass
Cape Town, South Africa
Chris Losinger wrote:
i hate needles so much i can't even imagine allowing one near The Little Programmer
|
|
|
|
|
Paul Watson wrote:
LOL, I said that? Hell, better go search for it to remember.
You say a lot of things, most of which is quickly forgotten (fortunately) 
Paul Watson wrote:
And I am honoured of course
You have been my sig for a long time now, and you only just noticed?  I think I will have to increase my volume of posts (which is likely with me being a project leader for the UGLY team).
It may also be time for a sig change. Looks like I will have to keep my eyes open for likely candidates.
Roger Allen
Sonork 100.10016
Were you different as a kid? Did you ever say "Ooohhh, shiny red" even once? - Paul Watson 11-February-2003
|
|
|
|
|
Inaugural CP2 Post (May 29, '03)[^]
Summary:
58 volunteers
jdunlap, jhaga, Jason Henderson, Anders Molin, Zachery, Chris Richardson, Brian Delahunty, RabidKangaroo, Daniel Turini, theRealCondor, Tom Welch, Navin, ballyduff, Jörgen Sigvardsson, Nitron, Simon Steele, Tomas Petricek, (Steven Hicks)n+1, Kant, geo_m, Joel Lucsy, Nathan Blomquist, dabs, Russell Morris, Chris Austin, Ryan S. Roberts, Ray Cassick, Weiye Chen, Notorious SMC, Heinz R. Vahlbruch, Derek Lakin, Sijin, Rage, Dominik Reichl, Robert Little, Roger Allen, Pete Bassett, Mark Conger, Nnamdi Onyeyiri, BenjaminAlicea, John Fisher, Marc Clifton, Steven Lyons, Rocky Moore, Michael Mac, James T. Johnson, Paul Watson, Joel Holdsworth, Shog9, Trollslayer, A. Riazi, peterchen, Kastellanos Nikos, Terry Denham, Vikram Punathambekar, CJOakwood, wiseguy_2112, Christian Graus
34 project ideas voted down to 10
-----------------------------
Choosing of the top 3 Projects (Jun 2, '03)[^]
Summary:
CP2 Coordinator's Steps of the process outlined and voting on top 3 project ideas takes place.
-----------------------------
Final Results of Top 3 Vote (Jun 3, '03)[^]
Summary:
Final voting results:
Score, IDEAS for CPP, (# votes)
3.9 Defect Tracking/Source Versioning (32)
3.8 Universal Gui LibrarY (40)
3.7 Application Framework (31)
3.5 project management system (25)
3.1 ASP.NET web controls replacement library (29)
3.1 threads and multi-processors (26)
3.1 CP Community Tools (24)
3.0 Alife/AI (26)
2.8 Code snippet library (23)
2.0 online task manager (20)
-----------------------------
Choosing Project Leaders (Jun 3, '03)[^]
Summary:
Nominations:
Anders Molin, Paul Watson - Defect Tracking/Source Versioning
Tom Welch, Roger Allen - Universal Gui LibrarY
Marc Clifton - Application Framework
-----------------------------
Phase Outline for Projects (Jun 4, '03)[^]
Summary:
Marc Clifton named Project Leader of the Application Framework
Anders Molin named Project Leader of Defect Tracking/Source Versioning
Roger Allen named defacto Project Leader of Universal Gui LibrarY
Phase Outline given and discussed.
-----------------------------
Application Framework Survey (Jun 4, '03)[^]
Summary:
Request for ideas on the Application framework called by Project Leader Marc Clifton. STILL IN PROGRESS
-----------------------------
Defect Tracking/Source Control Survey (Jun 5, '03)[^]
Summary:
Request for ideas on the Defect Tracking/Source Control project called by Project Leader Anders Molin. STILL IN PROGRESS
-----------------------------
U.G.L.Y. Survey (Jun 5, '03)[^]
Summary:
Request for ideas on the Universal Gui LibrarY called by Project Leader Roger Allen. STILL IN PROGRESS
-----------------------------
CP2 RFC-01 [LEADERSHIP STRUCTURE] (Jun 5, '03)[^]
Summary:
Request For Comments on how the project leadership/team member roles should be structured.
-----------------------------
CP2 RFC-02 [CRITICAL DOCUMENT TEMPLATES] (Jun 6, '03)[^]
Summary:
Request For Comments on critical documents such as Design Document. Are they needed, and does anyone have any templates?
Jason Henderson My articles
"The best argument against democracy is a five-minute conversation with the average voter." - Winston Churchill
|
|
|
|
|
Has there been any movement on the CP side of getting an area for these types of posts? I would like to see a CP Digest "article" and project "articles" separate from the message boards but that would not fit well with the "real Articles".
|
|
|
|
|
Chris has been gone at TechEd in Dallas, so no there hasn't been anything like this done yet. At least he hasn't made it known yet.
I'm going to post an article series format for review later today so check back tonight.
Jason Henderson latest CPP news
"If you are going through hell, keep going." - Winston Churchill
|
|
|
|
|
That digest was so fantastic that I am afraid you have shot yourself in the foot because now we will want one each week 
BTW has anyone even had a brief look at how projects such as Mozilla (Firebird, Thunderbird, Gecko) were done? Whatever one says about open source, Mozilla produced at least one fantastic product. Might be worth checking out their methods and processes. Obviously their scope and depth is far greater than ours at the moment but there may be things to learn from them (And I dare say managing that lot must be more difficult than a bunch of CPians.)
Paul Watson
Bluegrass
Cape Town, South Africa
Chris Losinger wrote:
i hate needles so much i can't even imagine allowing one near The Little Programmer
|
|
|
|
|
Requested by: Jason Henderson
All Request For Comments (RFC) should be posted on my message board[^] where I will then post them here at the proper time.
BEGIN
=================================================
We need templates or guidlines for writing some critical documents.
1) Design Document
2) guidelines for enhancement suggestions or initial ideas (may not be critical)
3) Project Timeline
4) QA checklists?
First of all, do we need some of these? Which do you think are necessary and which aren't (and why)? Any others?
Second, what needs to be in these documents?
If you have some templates, please submit them for review... somehow. 
=================================================
END
Jason Henderson My articles
"The best argument against democracy is a five-minute conversation with the average voter." - Winston Churchill
|
|
|
|
|
Design document - ESSENTIAL - so that we know what we're doing and how we're doing it, and what we're not doing. I can help out with this. I'm designing a template, and if I like it myself, I'll upload it to my only hosting area that has space.
guidelines for enhancement suggestions or initial ideas - ???
Project Timeline - we should outline a project timeline, but we probably won't stick to it (although, of course, we should try to ).
Jason Henderson wrote:
QA checklists?
For some reason, this term doesn't ring a bell with me. (DOH)
"Blessed are the peacemakers, for they shall be called sons of God." - Jesus
"You must be the change you wish to see in the world." - Mahatma Gandhi
|
|
|
|
|
jdunlap wrote:
guidelines for enhancement suggestions or initial ideas
how they should be submitted to the team for review
jdunlap wrote:
Project Timeline - we should outline a project timeline, but we probably won't stick to it
we need a basic template for this type of document since I think we need one too.
jdunlap wrote:
QA checklists?
For some reason, this term doesn't ring a bell with me. (DOH)
Quality Assurance (testing) checklists
Jason Henderson My articles
"The best argument against democracy is a five-minute conversation with the average voter." - Winston Churchill
|
|
|
|
|
There was one further design document we need. A coding standard, so that code developed by various people all has the same layout/naming convensions.
This can have a big effect as people will not have to re-work what they have developed to bring it all into one cosistent layout.
Roger Allen
Sonork 100.10016
Were you different as a kid? Did you ever say "Ooohhh, shiny red" even once? - Paul Watson 11-February-2003
|
|
|
|
|
Roger Allen wrote:
There was one further design document we need. A coding standard, so that code developed by various people all has the same layout/naming convensions.
Good point.
What standards would you like to use for your project?
Jason Henderson My articles
"The best argument against democracy is a five-minute conversation with the average voter." - Winston Churchill
|
|
|
|
|
Jason Henderson wrote:
What standards would you like to use for your project?
Not Hungarian Notation 
- Anders
Money talks, but all mine ever says is "Goodbye!"
|
|
|
|
|
I hate it too.
I alwas start my ints with i's not n's.
Jason Henderson My articles
"The best argument against democracy is a five-minute conversation with the average voter." - Winston Churchill
|
|
|
|
|
I have been working on project where some people used Hungarian Notation, and some did not.
It was really not a big issue, because we accepted the others style, and everyone was happy because they could code using their own style...
- Anders
Money talks, but all mine ever says is "Goodbye!"
|
|
|
|
|
Telling your team how to write readable code is a good thing.
You're not going to change the way a particular team member writes code in a general sense, but you can tell them what is acceptable and what isn't.
int i; // bad
int iCounter; // good
int iCounterForJasonsWidgetClass; // too much
That sort of thing.
Jason Henderson latest CPP news
"If you are going through hell, keep going." - Winston Churchill
|
|
|
|
|
What about
for (int i = 0; i < 10; i++)
{
}
- Anders
Money talks, but all mine ever says is "Goodbye!"
|
|
|
|
|
there are exceptions 
Jason Henderson latest CPP news
"If you are going through hell, keep going." - Winston Churchill
|
|
|
|
|
Anders Molin wrote:
Not Hungarian Notation
I am not a fan of hungarian notation, but it is useful when its limited in some ways:
m_ for a member var
s_ for a static member var
m_bVariable for bools/flags
I don't really care about the rest, as long as its descriptive so you can tell what a variable is for!
Whats really more important is the encapsulation and const correctness of the code.
Roger Allen
Sonork 100.10016
Were you different as a kid? Did you ever say "Ooohhh, shiny red" even once? - Paul Watson 11-February-2003
|
|
|
|
|
The design document is more than just a few pages of design stuff. The "design document" lives in spirit and name only and is comprised of several parts as well as a coherent underlying arcetechture. The design document is best represented by the following components:
1. A system design document.
2. An interface control document.
3. A system-level requirements document.
4. A software-level requirements document.
5. A requirements testing and tracibility document.
6. A software process and quality control document.
However, we need to take a few steps back before we can really go forward. We need to start at the preliminary design phase. This phase is the most informal phase of system design. This is where we start brainstorming over what the project entails and what it's final goals and visions are. We need to clearly discuss the need for our software, the problems and shortcomings it's going to solve, and how the customer will use it. We are really approaching the "sizing" phase. That is literally what it means, we begin to "size" the project and see how big or small everything really is. We then talk about the interface. How is the customer going to use our product? The interface is the most important aspect of the system because that's what the customer sees.
---ASIDE---
I use the term "customer" quite loosely. "Customer", as we need to define it here, is anyone who will be using our code, be it in terms of some final application, or as a functional library. We have both internal and external customers. Everyone on the team will be a supplier or a customer to another member of the team several times throughout the project lifecycle.
---/ASIDE---
---ASIDE2---
I remember going through this stuff in my senior design class and it made no sense to me whatsoever. It wasn't until I was out in the proverbial "real world" that I saw all this stuff in action. So in this light, I will try to clearly explain the design process as we go. If anything is vague or ambiguous, don't hesitate to ask for clarification.
---/ASIDE2---
Anyway, for a preliminary outline for the system design document, I would break it up as follows:
I. Abstract
A. What problem or shortcoming is the system going to solve?
(here we state the case for the project and justify why we are doing it)
B. How does the system solve that problem?
(high-level here, not too much detail)
C. How do you plan on implementing the system?
(process, not details!)
D. How do you plan on tracking progress?
(project-manager type stuff. waaay more on that later, it's a biggie)
E. How do you plan to prove the system does what it claims to do?
(the testing and QC processes go here)
II. Introduction
A. The Promlem / Shortcoming (whatever it is we're going to address)
1. Define the problem in detail.
B. Solution
2. Define the system-level solution here.
(everything here will be in terms of the external customer point of view)
III. Details
(here we introduce our other documents and provide their meaning and justification)
A. - F. (An overview of the documents listed above)
IV. Appendices
A. - ?. Timelines, schedules, org-charts, deliverable dates and milestones, etc.
Anyway, that's just a quick initial stab. These things don't take solid form overnight, they need to cure for a while...
- Nitron
"Those that say a task is impossible shouldn't interrupt the ones who are doing it." - Chinese Proverb
|
|
|
|
|
1. General Information
a. What is the problem?
b. What is the proposed solution?
c. What is the cost benefit of the solution?
2. Current Practices/Procedures
a. How is this problem being solved currently?
b. Who is involved in the current process?
c. What are their responsibilities?
d. What processes/knowledge is "hidden", and by whom?
3. Changes To Practices/Procedures
a. What changes are proposed?
b. Who are the people affected?
c. How are their responsibilities changed?
d. What training/documentation support will be required?
e. Who maintains the new implementation?
4. Technologies
a. What existing technologies will be used?
b. What new technologies need to be developed?
c. Cost/Stability/Maintainability/Documentation of all technologies
5. Design Overview
a. High level concepts/components/modules/functions
b. Identification of concerns: high level interactions
c. Identification of interests: who needs to know what from whom? (not people but concepts)
d. Early identification of trouble spots
e. Prototypes required
f. Planned QA / Test bed processes
g. Instrumentation/Profiling plans
h. Documentation plans
i. Error management (hardware, third party, internal)
6. Detail Design
a. Flowcharts
b. State diagrams
c. Design Patterns--how will separation of concerns be implemented?
d. Data Management
1) data lifetime
2) data persistence
3) data transfer between components
e. User Interface Prototype
f. Database Schema Prototype
g. Error handling/recovery
h. Psuedo-code
7. Design Iteration
a. Identify areas of risk, requiring design review/changes
b. Identify areas of lack of information, requiring further design depth
c. Identify areas of innovation, suggesting risk, buy in problems, or maintenance problems
Marc
Help! I'm an AI running around in someone's f*cked up universe simulator.
Sensitivity and ethnic diversity means celebrating difference, not hiding from it. - Christian Graus
Every line of code is a liability - Taka Muraoka
Microsoft deliberately adds arbitrary layers of complexity to make it difficult to deliver Windows features on non-Windows platforms--Microsoft's "Halloween files"
|
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
