psifidotos / workflow-project

This is an effort to create a KDE Plasmoid that integrates the main Activities, Virtual Desktops and Tasks Functionalities from Plasma Desktop in just one component.
http://workflow.opentoolsandspace.org/
GNU General Public License v2.0
11 stars 2 forks source link

Create Documentation / Wiki #69

Open psifidotos opened 11 years ago

psifidotos commented 11 years ago

It would be very productive to have documentation. I have create in google docs a document:

https://docs.google.com/document/d/1PTGs_kmwDe3Ov331tBgQBDTgIVTB6OMIpvwMzygOhEc/edit#

in order to create a collaborative effort. If anyone is interested just tell... A team of 2-3 persons is more than enough, I dont think it's goind to be very big...

bmihaila commented 11 years ago

Hi

I would want to help with the docu but why don't we take the github wiki here on this site https://github.com/psifidotos/workflow-project/wiki ? You could then link from the main project site to the wiki as the documentation. Somehow the google docs is more like a static document as the documentation should be something that is updated often.

psifidotos commented 11 years ago

Yes of course no problem, github says that is like a simple repo. I like wiki style also.

BTW, try the latest version, it supports global hotkeys, you asked for :-) ... Óôéò 18 Öåâ 2013 2:11 ð.ì., ï ÷ñÞóôçò "Bogdan Mihaila" < notifications@github.com> Ýãñáøå:

Hi

I would want to help with the docu but why don't we take the github wiki here on this site https://github.com/psifidotos/workflow-project/wiki ? You could then link from the main project site to the wiki as the documentation. Somehow the google docs is more like a static document as the documentation should be something that is updated often.

Reply to this email directly or view it on GitHubhttps://github.com/psifidotos/workflow-project/issues/69#issuecomment-13700829.

bmihaila commented 11 years ago

Just tried the latest version, really cool! All the things I was missing from activities came now true, thx to you.

Ok, I will then gradually start adding some FAQs to the wiki the next days ... maybe even some stubs for the features. I guess the introduction and Concept parts are more up to you ;)

psifidotos commented 11 years ago

Yes of course, dont worry...., once there is some work in the wiki I will help....

I guess the introduction and Concept parts are more up to you ;)

bmihaila commented 11 years ago

Hi I started some documentation https://github.com/psifidotos/workflow-project/wiki/Workflow-Project At the moment it lists the major features and some FAQ. Needs some polishing I guess and some more FAQ but its a start.

bmihaila commented 11 years ago

We will have to think how to organize the wiki. Here some issues:

bmihaila commented 11 years ago

Ooh, one more thing. In the "Concept" paragraph you need to stress the differences and commonalities between (virtual) desktops and Workareas. That there are two different terms and what they mean and that they are sometimes used interchanged was quite confusing for me at the beginning. So you should name them and state what they are and what not and from then on stick with Workareas as to not confuse people.

psifidotos commented 11 years ago

Ooh, one more thing. In the "Concept" paragraph you need to stress the differences and commonalities between (virtual) desktops and Workareas. That there are two different terms and what they mean and that they are sometimes used interchanged was quite confusing for me at the beginning. So you should name them and state what they are and what not and from then on stick with Workareas as to not confuse people.

Good Idea I will use references from the original text from which this project derived....

psifidotos commented 11 years ago

Hi I started some documentation https://github.com/psifidotos/workflow-project/wiki/Workflow-Project At the moment it lists the major features and some FAQ. Needs some polishing I guess and some more FAQ but its a start.

Very good, I will add soon the concept text....

psifidotos commented 11 years ago

We will have to think how to organize the wiki. Here some issues:

  • subpages for the topics or one big page?

I think that we can stick with one page for the time....

  • what things to add there? (installation, links to videos, screenshots etc..)

Installation: agree Videos & Screenshots: I dont think is necessary we can create links to the original project page... http://opentoolsandspace.org/en/projects/development/plasmoid-workflow I upload screenshots and videos for each major version there...

  • merge things from features and interface?

Agree, even though I can not think what to add in the interface...

  • be concise and short like I wrote things now or with longer descriptions (more like a manual)

I prefer short texts, in order to be read easily....

psifidotos commented 11 years ago

Ok... The concept is ready take a look at it....

One more thing, I changed my opinion (Concept is very big and I can not make it smaller... :) ), I believe we could separate the wiki in the following: Main page with Introduction and links for all the rest sub-sections e.g.: Concept, Features, FAQ

what do you think?

bmihaila commented 11 years ago

Yes agree with the separation. I will have a second look at it the next days to see if something is missing.