Analogue-sequencer

Colin - being a sw developer myself, I know that documentation is often the last thing on the list and the most loathesome of tasks.

I have a proposal - would it be possible to provide a general outline of a document in some standard format (MS Word for example), along with pointers to existing P3 docs (if applicable), and then have the community create the user manual with you doing the proofing and corrections if we document a feature incorrectly?

Also - if there was an easy way to do screen captures on the Cirklon, that would go a long way to making the doc more usable.

The way I see it, people could sign up for a feature or menu and document it extensively and then you could stitch the pieces together and we might then have a useful document quicker than if the burden fell solely on you.

Thoughts?

How about setting up a wiki instead of MS Word... much more sharing friendly ;-)

Ian



--- In analogue-sequencer@yahoogroups.com, "tmoravan" <tmoravan@...> wrote:

>
> Colin - being a sw developer myself, I know that documentation is often the last thing on the list and the most loathesome of tasks.
> 
> I have a proposal - would it be possible to provide a general outline of a document in some standard format (MS Word for example), along with pointers to existing P3 docs (if applicable), and then have the community create the user manual with you doing the proofing and corrections if we document a feature incorrectly?
> 
> Also - if there was an easy way to do screen captures on the Cirklon, that would go a long way to making the doc more usable.
> 
> The way I see it, people could sign up for a feature or menu and document it extensively and then you could stitch the pieces together and we might then have a useful document quicker than if the burden fell solely on you.
> 
> Thoughts?
>

--- In analogue-sequencer@yahoogroups.com, "Colin Fraser" <colin@...> wrote:
> 
> The idea of Wiki-based documentation does appeal.
> Not as the sole source - I fully intend to print up manuals.
> A ring binder containing a snapshot of Wiki-based documentation in a
> print-friendly format might be the best way to go.
> I have no idea how I would go about setting up a wiki.
> I guess I need some server-side scripting and a database.
> It's been a long time since I did that for a living.

There can be setup and hosted free here: <http://www.wikidot.com/>

Never done it though so I don't know if it's a good service. Maybe someone else has some experience with such a service provider ?

Ian

While I appreciate the videos, I would like to add my voice to the chorus -I
rely on documentation in learning instruments and i find that , even for
boutique intruments, , lack of or poor documentation can often harm the
product well beyond the developers expectation. Other than a complete os I
think that documentation that is adequate is the single most important thing
to me and many others I know. If an outline can be produced, I am a drafter
and can edit some narratives as time permits 9 after i get my machine of
course)

On Thu, May 5, 2011 at 9:41 AM, tmoravan <tmoravan@yahoo.com> wrote:

>
>
> Colin - being a sw developer myself, I know that documentation is often the
> last thing on the list and the most loathesome of tasks.
>
> I have a proposal - would it be possible to provide a general outline of a
> document in some standard format (MS Word for example), along with pointers
> to existing P3 docs (if applicable), and then have the community create the
> user manual with you doing the proofing and corrections if we document a
> feature incorrectly?
>
> Also - if there was an easy way to do screen captures on the Cirklon, that
> would go a long way to making the doc more usable.
>
> The way I see it, people could sign up for a feature or menu and document
> it extensively and then you could stitch the pieces together and we might
> then have a useful document quicker than if the burden fell solely on you.
>
> Thoughts?
>
>  
>


[Non-text portions of this message have been removed]

pardon my ignorance, but is there an easy way to go from an on-line Wiki format to a double-sided 8.5x11 (or A4) printed format that can be put in a ring binder and used without a computer nearby?



--- In analogue-sequencer@yahoogroups.com, "ianmantripp" <ianmantripp@...> wrote:

>
> 
> 
> --- In analogue-sequencer@yahoogroups.com, "Colin Fraser" <colin@> wrote:
> > 
> > The idea of Wiki-based documentation does appeal.
> > Not as the sole source - I fully intend to print up manuals.
> > A ring binder containing a snapshot of Wiki-based documentation in a
> > print-friendly format might be the best way to go.
> > I have no idea how I would go about setting up a wiki.
> > I guess I need some server-side scripting and a database.
> > It's been a long time since I did that for a living.
> 
> There can be setup and hosted free here: <http://www.wikidot.com/>
> 
> Never done it though so I don't know if it's a good service. Maybe someone else has some experience with such a service provider ?
> 
> Ian
>

> Colin - being a sw developer myself, I know that 
> documentation is often the last thing on the list and the 
> most loathesome of tasks.

Possibly more accurate to say it's the first thing on the list, but the last
to get done :-)

I have some sections of the Cirklon manual started, and a rough idea how I
will put them together.
The main problem getting it done is that a user manual is a snapshot of the
functionality at the time of writing.
I keep adding stuff, so the manual is going to be out of date the day after
I finish it.
I need to stop adding stuff for a bit, and write down what's there already.

The idea of Wiki-based documentation does appeal.
Not as the sole source - I fully intend to print up manuals.
A ring binder containing a snapshot of Wiki-based documentation in a
print-friendly format might be the best way to go.
I have no idea how I would go about setting up a wiki.
I guess I need some server-side scripting and a database.
It's been a long time since I did that for a living.

> Also - if there was an easy way to do screen captures on the 
> Cirklon, that would go a long way to making the doc more usable.

If you've seen the tutorial video on Youtube, the close-up view of the
display is actually a web-cam capture of a second display located behind my
Cirklon, slaved to the main display raster signals.
I can take native resolution screen-captures directly from that in GIF
format, inverting the colour to suit printing better.
That bit shouldn't be a problem.

Best regards,
Colin Fraser
Sequentix Music Systems Ltd
http://www.sequentix.com

On 05/05/2011 15:38, Colin Fraser wrote:

> I need to stop adding stuff for a bit, and write down what's there already.

Please don't. Happy to help folks through the early days of their 
machines as you continue doing things. Which reminds me, I was meant to 
verify some Logic/USB MIDI tests... :)

-- 
Paul
---
http://www.softroom.co.uk
http://www.youtube.com/WilyEPeyote

I agree that a WiKi would be better. We can all mess it up and Colin can 
get on with the crazy shit we are paying him for?

Cirklon is still in mid flight

Richard

> pardon my ignorance, but is there an easy way to go from an 
> on-line Wiki format to a double-sided 8.5x11 (or A4) printed 
> format that can be put in a ring binder and used without a 
> computer nearby?

That would probably be a manual job for me.

Best regards,
Colin Fraser
Sequentix Music Systems Ltd
http://www.sequentix.com

--- In analogue-sequencer@yahoogroups.com, "tmoravan" <tmoravan@...> wrote:
>
> pardon my ignorance, but is there an easy way to go from an on-line Wiki format to a double-sided 8.5x11 (or A4) printed format that can be put in a ring binder and used without a computer nearby?
> 

The wiki is not meant to be a replacement for a printed (or pdf) manual, but as an easy collaborative information sharing and writing tool.

Getting the data from the wiki into a page layout application may actually be easier than you may think. Using XSTL (xml transformation) or a custom db export to xml script, the data can easily be reused... how easily depends how the db is setup.

I have written such a script before which also added the InDesign styles markup. Once the layout template is made and styles defined, they just imported the xml and hey presto... the manual... well in that case in was a magazine.

Ian

> The wiki is not meant to be a replacement for a printed (or 
> pdf) manual, but as an easy collaborative information sharing 
> and writing tool.

That's how I was looking at it.
 
> I have written such a script before which also added the 
> InDesign styles markup. Once the layout template is made and 
> styles defined, they just imported the xml and hey presto... 
> the manual... well in that case in was a magazine.

Sounds simple...


Best regards,
Colin Fraser
Sequentix Music Systems Ltd
http://www.sequentix.com

+1 for a collaborative approach, +1 for a wiki. 
perhaps a reader-friendly, printable PDF can be assembled afterwards. 

though english isnt my native language, I'd love to contribute some content. 

cheers, 
roman


--- In analogue-sequencer@yahoogroups.com, "ianmantripp" <ianmantripp@...> wrote:

>
> How about setting up a wiki instead of MS Word... much more sharing friendly ;-)
> 
> Ian
> 
> 
> 
> --- In analogue-sequencer@yahoogroups.com, "tmoravan" <tmoravan@> wrote:
> >
> > Colin - being a sw developer myself, I know that documentation is often the last thing on the list and the most loathesome of tasks.
> > 
> > I have a proposal - would it be possible to provide a general outline of a document in some standard format (MS Word for example), along with pointers to existing P3 docs (if applicable), and then have the community create the user manual with you doing the proofing and corrections if we document a feature incorrectly?
> > 
> > Also - if there was an easy way to do screen captures on the Cirklon, that would go a long way to making the doc more usable.
> > 
> > The way I see it, people could sign up for a feature or menu and document it extensively and then you could stitch the pieces together and we might then have a useful document quicker than if the burden fell solely on you.
> > 
> > Thoughts?
> >
>

i've researched a bit about wikis. 

here you can can compare wiki systems, look for XML/PDF export: http://www.wikimatrix.org/search.php
wikidot does not support XML export.

the tracker guys from renoise.com have a mediawiki-generated PDF manual: http://tutorials.renoise.com/wiki/Main_Screen (PDF link: left sidebar at the bottom)
wikipedia is based on mediawiki, so it surely won't be abandoned in near future. for installation PHP 5.0+, mySQL 4.0+ and phpMyAdmin (webbased DB-client) is recommended.
 

cheers, 
roman


--- In analogue-sequencer@yahoogroups.com, "Colin Fraser" <colin@...> wrote:

>
>  
> > pardon my ignorance, but is there an easy way to go from an 
> > on-line Wiki format to a double-sided 8.5x11 (or A4) printed 
> > format that can be put in a ring binder and used without a 
> > computer nearby?
> 
> That would probably be a manual job for me.
> 
> Best regards,
> Colin Fraser
> Sequentix Music Systems Ltd
> http://www.sequentix.com
>

I'd help with the technical part, we have mediawiki at work too (I work as a web programmer).


--- In analogue-sequencer@yahoogroups.com, Ian Mantripp <ianmantripp@...> wrote:

>
> 
> 
> On Sunday 12 June 2011 at 10:18, dede wrote:
> 
> > the tracker guys from renoise.com (http://renoise.com) have a mediawiki-generated PDF manual: http://tutorials.renoise.com/wiki/Main_Screen (PDF link: left sidebar at the bottom)
> > wikipedia is based on mediawiki, so it surely won't be abandoned in near future. for installation PHP 5.0+, mySQL 4.0+ and phpMyAdmin (webbased DB-client) is recommended. 
>  That is very nice !! 
> 
> Colin, I am willing to do some work on graphics if required. Just let me know.
> 
> 
> Ian 
> 
> [Non-text portions of this message have been removed]
>

Thanks Roman, I'll have a look at it.

Cheers,
Colin 

> -----Original Message-----
> From: analogue-sequencer@yahoogroups.com 
> [mailto:analogue-sequencer@yahoogroups.com] On Behalf Of dede
> Sent: 12 June 2011 09:18
> To: analogue-sequencer@yahoogroups.com
> Subject: [analogue-sequencer] Re: eventual Cirklon documentation
> 
> i've researched a bit about wikis. 
> 
> here you can can compare wiki systems, look for XML/PDF 
> export: http://www.wikimatrix.org/search.php
> wikidot does not support XML export.
> 
> the tracker guys from renoise.com have a mediawiki-generated 
> PDF manual: http://tutorials.renoise.com/wiki/Main_Screen 
> (PDF link: left sidebar at the bottom) wikipedia is based on 
> mediawiki, so it surely won't be abandoned in near future. 
> for installation PHP 5.0+, mySQL 4.0+ and phpMyAdmin 
> (webbased DB-client) is recommended.
>  
> 
> cheers,
> roman
> 
> 
> --- In analogue-sequencer@yahoogroups.com, "Colin Fraser" 
> <colin@...> wrote:
> >
> >  
> > > pardon my ignorance, but is there an easy way to go from an 
> > > on-line Wiki format to a double-sided 8.5x11 (or A4) printed 
> > > format that can be put in a ring binder and used without a 
> > > computer nearby?
> > 
> > That would probably be a manual job for me.
> > 
> > Best regards,
> > Colin Fraser
> > Sequentix Music Systems Ltd
> > http://www.sequentix.com
> >
> 
> 
> 
> 
> ------------------------------------
> 
> Yahoo! Groups Links
> 
> 
>

On Sunday 12 June 2011 at 10:18, dede wrote:

> the tracker guys from renoise.com (http://renoise.com) have a mediawiki-generated PDF manual: http://tutorials.renoise.com/wiki/Main_Screen (PDF link: left sidebar at the bottom)
> wikipedia is based on mediawiki, so it surely won't be abandoned in near future. for installation PHP 5.0+, mySQL 4.0+ and phpMyAdmin (webbased DB-client) is recommended. 
 That is very nice !! 

Colin, I am willing to do some work on graphics if required. Just let me know.


Ian 

[Non-text portions of this message have been removed]

just to let you know: I've set up a test wiki environment (mediawiki), link and discussion can be found at the cirklon-beta group. 
cheers, roman