KDE Documentation/Meetings/Akademy 2010 BoF: Difference between revisions

From KDE Community Wiki
Line 23: Line 23:
quality of documentation
quality of documentation
* list on techbase
* list on techbase
* quality of documentation
* quality of documentation - Albert says there is a page about it, status is good, but translations lacking [http://techbase.kde.org/Projects/Documentation/KDE4_(health_table)]


what's this help, tooltips
what's this help, tooltips

Revision as of 10:05, 7 July 2010

Akademy 2010 BoF

See BoF schedule for date and time.

Agenda

  • Status of documentation (content, tools, community, ...)
  • Role of Wikis and forum in KDE documentation
  • Status of KHelpcenter
  • Brainstorming about future of KDE documentation
  • Planning for KDE documentation sprint

Input

Thread on kde-doc-english with lots of good input


BoF Notes

(notes by Frederik, please extend)

Doc english as mailing list: not the perfect list name

quality of documentation

  • list on techbase
  • quality of documentation - Albert says there is a page about it, status is good, but translations lacking [1]

what's this help, tooltips

  • tooltips too large: on small screen it covers too much

userbase documentation

  • parley manual as guinea pig
  • page size, images, links, semantics
  • versioning of manuals
  • file uploading
  • translation of screenshots

why not wiki to html/pdf directly


specify what should be in manuals (eg not "how to compile")

formats: gnome

offline docs

Annew:

  • people needed to do the incredibly boring stuff regularily - eg fix tamplates

blog on planetkde about userbase manual writing

classroom