[TYPO3-doc] Do you miss a HAT

Peter Kindström peter.kindstrom at abc.se
Fri Jul 7 23:51:28 CEST 2006


Hi Tim,
> I agree that we need to look at the entire process but i think that 
> Edwin meant that we would come a long way by offering good structured 
> documentation in an on-line version made by T3. The next step could be 
> to create different kind of off-line documentation. And i agree with 
> Edwin if this is the case.

Well, neither you or Edwin mentioned *structured* documentation 
in your first postings, so I only wanted to point that out 
specifically.

I think structure is the most important thing we need when it 
comes to T3 documentation, but of course a good HAT system would 
make the management much easier!


> It is difficult to find the documentation, I have been using T3 for 
> about 3 years and I still come across a piece of information that I 
> didn't expect to find at that spot.

I know, I have the same problem and I have thought about an 
solution for more than a year now!

My solution is to structure documentation, but I guess I have 
not thought so much about how to get/maintain that structure. 
And you suggest a HAT system and assumes it has/gets a good 
structure...?


> Use the HAT to make the structure. With the right HAT system you are 
> able to organize the same information to be presented on many levels 
> from beginners to advanced users and updates will be reflected right 
> away thruout the entire documentation.

Yes, I guess that is the way to go!


> When lacking a HAT wiki is good alternative but T3 and the comunity is 
> at such a scale now that we have to take documentation to anoter level.

Documentation should be devided into three "groups":
  User documentation
  Developer documentation
  Extension documentation

I have quit a good idea about how to organise User documentation 
(http://www.abc.se/~m4661/typowiki/) but I have not thought of 
the others yet. And I really think we should leave the other two 
groups out for a while and test this idea with only User 
documentation (but have the others in mind when planning, of 
course).

Tim, are you serious about setting up a test HAT system? It 
would be nice to see what you have in mind!


---------
Sorry about my wiki pages. They crashed and now I have 
reinstalled MediaWiki but cannot login any more. And all pages 
are protected from editing by non-logged-in users...  :-(


-- 

Peter Kindström



More information about the TYPO3-project-documentation mailing list