T3Doc/doc core cgl
From TYPO3Wiki
| Teams R&D-Committee | This page belongs to DocTeam (Members|Contact). see our current activities |
| Support for good documentation is our mission. | |
TYPO3 Coding Guidelines
Official document: TYPO3 Coding Guidelines -- The author of the OpenOffice-document is Kasper, this wiki-page are contributions from DocTeam and others.
Contents |
New contribution: The Concept
This is a brainstorming'N'analyse-phase/ document in progress in the moment, because it's just a collection from the discussion-texts. Please contribute and add what is important. kind regards, DocTeam, --Daniel Brüßler 23:29, 12 October 2006 (CEST)
background-story: Discussion driven by JoH aka Joey about concepts in TYPO3-Projects.
Analysis - what is now
The true fact is, that just a little number of the concepts are _published_. The most are on paper or in the talks/ newsgroups, that's just another form of "media".
The reason is that almost the people have to do the coding who have the idea!! So it often makes not much sense to make much documentation and big concepts before implementing it.
The coding-guidelines for extension-writers have a section that documentation is _very_ important http://typo3.org/documentation/document-library/core-documentation/doc_core_cgl/current/view/1/2/
The concepts have several places
- The most agile and fast way: the concept is known by the people who follow the fire -- that means: in the talks, the texts of the newsgroups, in fast feedback, in the heads of one ore more people
- Big long term projects: http://typo3.org/development/projects/
- Smaller projects: projects in the wiki : http://wiki.typo3.org/index.php/Projects -
- Projects driven by long-term-teams: team-projects in the wiki http://wiki.typo3.org/index.php/Teams -
Brainstorming
I think it's possible, that all steps can just last 2..5 days !!
This should be agile. (light-weighted time&energy, heavy-weight time&energy)
- Publish that there will be a new project, what the story is, WHEN IMPLEMENTATION STARTS
- Wishlist collection (or some variation ideas of others)
- List of people who REALLY want to do a part of the todo-list (who and what) and start of fundraising (the question is who supports what feature)
- FAST concept (collection of some texts, scan of a paper-diagramm, screenshots, links to video or mp3, notes of talks) with simple todo-list
- Decisions what parts of the Wishlist the developer(s) want to do
- Better concept and functional prototype(s)
- Implementation in team or by just one person (!)
- Publish, Integration-Tests by all people/ the team/ just by one person, check of bugs and some problems
conclusion: Wishlist
- check who would use the wiki - and under which requirements
- check if a subst {{subst:p}} would have a good usability to create the whole page-structure
- check if an extension at typo3.org or a PDF somewhere would be better
- check what points must be very lightweighted in a developer-sight
- check when I should ask for helpers
- see Talk:Projects
