Maemo-Barcelona Long Weekend/Documentation - Revision history

imported_>amigadave at 16:29, 11 February 2010

2010-02-11T16:29:06Z

← Older revision		Revision as of 16:29, 11 February 2010
Line 71:		Line 71:
	* [[Contributing to the wiki]] guide		* [[Contributing to the wiki]] guide
	* [[Developer Guide table of contents]] sketch		* [[Developer Guide table of contents]] sketch

			[[Category:Maemo-Barcelona Long Weekend]]

imported_>dneary: Add notes from docs summit

2009-12-10T17:25:14Z

Add notes from docs summit

← Older revision		Revision as of 17:25, 10 December 2009
Line 3:		Line 3:
	'''This wiki page is complemented by [http://talk.maemo.org/showthread.php?t=34605 this discussion thread]'''		'''This wiki page is complemented by [http://talk.maemo.org/showthread.php?t=34605 this discussion thread]'''

	~~There will be a~~ Documentation workshop in Barcelona~~, where we will discuss the~~ needs of user and developer documentation during a half day, and have a "docfest" to work on a specific wiki task for another half day.		A Documentation workshop was held as part of the Maemo Long Weekend in Barcelona. The needs of user and developer documentation for maemo.org were discussed during a half day, and have a "docfest" to work on a specific wiki task for another half day.

	Just now our minds are being boggled by questions on Maemo documentation. Things like: what kind of info is needed, by what kinds of users, how should it be structured so that everyone finds what they need, what's the easiest way for you to add information, questions, answers, etc? How can we get more and better info onto maemo.org, how can we get beginners up and running in the quickest way possible? What questions are boggling your mind? Where do you look for answers?		Just now our minds are being boggled by questions on Maemo documentation. Things like: what kind of info is needed, by what kinds of users, how should it be structured so that everyone finds what they need, what's the easiest way for you to add information, questions, answers, etc? How can we get more and better info onto maemo.org, how can we get beginners up and running in the quickest way possible? What questions are boggling your mind? Where do you look for answers?
Line 44:		Line 44:
	* [http://maemo.org/profile/view/sebas/ Sebastián Colomar] - Maemo Wiki volunteer		* [http://maemo.org/profile/view/sebas/ Sebastián Colomar] - Maemo Wiki volunteer

	== ~~Developer ToC~~ ==		== Notes ==
	* Setup
	** Hardware
	*** PC
	*** Mac
	*** Windows
	** SDK
	*** Install
	*** Code
	**** C
	**** C++
	**** Python
	** Getting Src
	*** DVCS
	** Compile + Build
	** Package
	** Delivery
	*** Extras Repository
	*** Ovi
	** Test
	*** Tools
	*** Process
	*** QA
	** Appendix: Reference Links
	~~Including~~
	*** Detailed Reference Material
	*** UI Guidance
	*** UX Links

	* ~~Lego~~		=== Dave Neary ===
	*** Software Architecture (top-~~down approach)~~
	*** Flow Suggestion		'''Shortcomings'''
	~~Start with 'upstream' and core linux~~
	*** gtk		* Need aggregation pages which give you a summary of everything to do
	*** dbus		with X - link collections.
	*** kernel		* Search on maemo.org sucks for finding answers to questions. Straight
	~~Move~~ on ~~to Maemo services~~. ~~Focus on high level APIs first and move~~ on		Google search works better.
	to ~~deeper ones (reflects order~~ of ~~interaction for dev)~~		* Need to be able to link directly to the user guide & style guides from
	*** location		the wiki. Need to be able to link to sections
	~~**~~ (~~library / interfaces / api~~)		* Intro does not serve any of maemo.org target audiences
	**** best practice		* Search bar on maemo.org isn't very obvious on Support or Development
	**** tutorial / example		* No obvious way to navigate to a list of all applications à la Nokia's
	*** telephony		"community applications" page
	*** gpio
	*** multimedia framework		'''Gap analysis'''
	*** contacts		* Need help! (Support page) (Improved, but needs more work)
	* ~~Appendix Machine Architecture~~		* Page(s) pointing to code samples with a description of what they do -
	* ~~Integration Tutorial~~		links need to be in developer guide too
			* Signposting - sites, roles, when are we in a wiki, when are we not?

			'''Concrete results'''
			* [http://maemo.org/support Support page]
			* [[Contributing to the wiki]] guide
			* [[Developer Guide table of contents]] sketch

imported_>lbt: Save ToC

2009-12-10T14:16:22Z

Save ToC

← Older revision		Revision as of 14:16, 10 December 2009
Line 43:		Line 43:
	== Participants ==		== Participants ==
	* [http://maemo.org/profile/view/sebas/ Sebastián Colomar] - Maemo Wiki volunteer		* [http://maemo.org/profile/view/sebas/ Sebastián Colomar] - Maemo Wiki volunteer

			== Developer ToC ==
			* Setup
			** Hardware
			*** PC
			*** Mac
			*** Windows
			** SDK
			*** Install
			*** Code
			**** C
			**** C++
			**** Python
			** Getting Src
			*** DVCS
			** Compile + Build
			** Package
			** Delivery
			*** Extras Repository
			*** Ovi
			** Test
			*** Tools
			*** Process
			*** QA
			** Appendix: Reference Links
			Including
			*** Detailed Reference Material
			*** UI Guidance
			*** UX Links

			* Lego
			*** Software Architecture (top-down approach)
			*** Flow Suggestion
			Start with 'upstream' and core linux
			*** gtk
			*** dbus
			*** kernel
			Move on to Maemo services. Focus on high level APIs first and move on
			to deeper ones (reflects order of interaction for dev)
			*** location
			**** (library / interfaces / api)
			**** best practice
			**** tutorial / example
			*** telephony
			*** gpio
			*** multimedia framework
			*** contacts
			* Appendix Machine Architecture
			* Integration Tutorial

imported_>sebas: /* Participants */

2009-12-03T00:22:03Z

Participants

← Older revision		Revision as of 00:22, 3 December 2009
Line 42:		Line 42:

	== Participants ==		== Participants ==
	* [http://maemo.org/profile/view/sebas/ Sebastián Colomar] - ~~General interest in end-user performance experience...~~		* [http://maemo.org/profile/view/sebas/ Sebastián Colomar] - Maemo Wiki volunteer

imported_>sebas: /* Participants */

2009-12-03T00:21:29Z

Participants

← Older revision		Revision as of 00:21, 3 December 2009
Line 42:		Line 42:

	== Participants ==		== Participants ==
			* [http://maemo.org/profile/view/sebas/ Sebastián Colomar] - General interest in end-user performance experience...

62.61.94.1: /* Schedule */

2009-12-02T06:51:47Z

Schedule

← Older revision		Revision as of 06:51, 2 December 2009
Line 40:		Line 40:
	: '''Morning:'''		: '''Morning:'''
	: Continue workshop from Saturday, or participate in [[../UX meets Code \| UX meets Code]] workshop (to be decided)		: Continue workshop from Saturday, or participate in [[../UX meets Code \| UX meets Code]] workshop (to be decided)

			== Participants ==

imported_>dneary: /* Documentation workshop */

2009-11-27T10:55:11Z

Documentation workshop

← Older revision		Revision as of 10:55, 27 November 2009
Line 1:		Line 1:
	= Documentation workshop =		= Documentation workshop =

	This wiki page is complemented by [http://talk.maemo.org/showthread.php?t=34605 this discussion thread]		'''This wiki page is complemented by [http://talk.maemo.org/showthread.php?t=34605 this discussion thread]'''

	There will be a Documentation workshop in Barcelona, where we will discuss the needs of user and developer documentation during a half day, and have a "docfest" to work on a specific wiki task for another half day.		There will be a Documentation workshop in Barcelona, where we will discuss the needs of user and developer documentation during a half day, and have a "docfest" to work on a specific wiki task for another half day.

imported_>qgil at 19:09, 26 November 2009

2009-11-26T19:09:54Z

← Older revision		Revision as of 19:09, 26 November 2009
Line 1:		Line 1:
	= Documentation workshop =		= Documentation workshop =

			This wiki page is complemented by [http://talk.maemo.org/showthread.php?t=34605 this discussion thread]

	There will be a Documentation workshop in Barcelona, where we will discuss the needs of user and developer documentation during a half day, and have a "docfest" to work on a specific wiki task for another half day.		There will be a Documentation workshop in Barcelona, where we will discuss the needs of user and developer documentation during a half day, and have a "docfest" to work on a specific wiki task for another half day.

62.61.94.1: /* Documentation workshop */

2009-11-19T13:57:19Z

Documentation workshop

← Older revision		Revision as of 13:57, 19 November 2009
Line 7:		Line 7:
	And most of all: how should Maemo documentation be produced in the future? How can we ensure that community participation in documentation writing and maintenance continues to be possible?		And most of all: how should Maemo documentation be produced in the future? How can we ensure that community participation in documentation writing and maintenance continues to be possible?

	Join us to brainstorm on this important area!		Join us to brainstorm on this important area!

			In addition, we are asking people for short interviews on their exepriences with Maemo documentation throughout the weekend. This involves chocolate!


	== Schedule ==		== Schedule ==

62.61.94.1: /* Schedule */

2009-11-19T13:54:51Z

Schedule

← Older revision		Revision as of 13:54, 19 November 2009
Line 23:		Line 23:
	:* How can we ensure that the Maemo wiki grows in a healthy way?		:* How can we ensure that the Maemo wiki grows in a healthy way?
	:* Should the focus of efforts be on writing new material or on cleaning up existing material?		:* Should the focus of efforts be on writing new material or on cleaning up existing material?
			:* What are the main places where newcomers look for information?
			:* Where do more experienced Maemo community members go for information?


	: '''Afternoon:'''		: '''Afternoon:'''