U++ framework
Do not panic. Ask here before giving up.
Home » Developing U++ » Documentation » Idea...
Re: Idea... [message #22271 is a reply to message #22270] Mon, 29 June 2009 10:08 Go to previous messageGo to previous message
koldo is currently offline  koldo
Messages: 3461
Registered: August 2008
Senior Veteran
luzr wrote on Mon, 29 June 2009 09:10

koldo wrote on Mon, 29 June 2009 02:36

Hello Mirek

- One thing I would like is to have a documentation full copy in one file. It would be easy to handle and print.

- Other thing we have been talking about is to have a clear "Contents". Through "Contents" it is:
1. Easier to look for info
2. We can include also subjects to be included, so it would be easier for new documentators to choose in which area the can help

- Mirek, Please do a "Contents" with areas now documented and not documented. After that ask the people to choose what they want to document. We have there a good "Contents" sample in http://www.ultimatepp.org/forum/index.php?t=msg&goto=216 89&.

Just move it on Smile

Best regards
Koldo


Well, just tell where it does fit... I mean, I can imagine the content on website.

It is however maybe a little bit more problematic as part of help system: There is still an idea that documentation is modular, therefore each package has its docs and packages can be added / removed as needed...

Mirek


Hello Mirek

Using the qprentice "Contents" proposal in http://www.ultimatepp.org/forum/index.php?t=msg&goto=216 89&. you can define the main structure and fill it with the existing help contents and a simple empty screen with a "To Be Documented" in the chapters not documented yet.

Then you can ask people to fill those gaps or to add new chapters that fit in the main "Contents" structure. Bazaar documents could fit in an "Appendix" section at the end.

And it could be great the possibility to hardcopy all in a single document that can be copied and printed as a whole. You can publish it and earn a bunch of money! Smile

Best regards
Koldo

Best regards
Iñaki

Report message to a moderator

[Message index]
 
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Previous Topic: an error in manual
Next Topic: Mistake in Character Set Support Documentation
Goto Forum:
  

[ Syndicate this forum (XML) ] [ RSS ] [ PDF ]

Current Time: Fri Sep 18 17:34:16 GMT+2 2026

Total time taken to generate the page: 0.00794 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.2.0.
Copyright ©2001-2025 FUDforum Bulletin Board Software