I'm considering updating the manual

Subforum for general discussions. Do not dump your questions/problems here, but try to find the subforum where it belongs!
Post Reply
User avatar
mack
Posts: 27
Joined: Friday 08 April 2016 8:23
Target OS: Raspberry Pi
Domoticz version: Stable
Location: Dallas, USA
Contact:

I'm considering updating the manual

Post by mack » Saturday 07 October 2017 2:17

The manual -- the PDF linked from the front page -- needs a bit of work to stay useful. I'm considering updating it, and during the process would suggest moving to something easily updated in a collaborative manner like MarkDown on github. But, before I start that, I'd ask if this update is desired.

Conversely, instead of updating this Manual, should we simply consolidate the information there into the wiki and use the wiki as the Manual? I see benefits to either argument, but would like to know what our overlords would prefer. :D

User avatar
remb0
Posts: 826
Joined: Thursday 11 July 2013 22:21
Target OS: Raspberry Pi
Domoticz version: Beta
Location: The Netherlands
Contact:

Re: I'm considering updating the manual

Post by remb0 » Saturday 07 October 2017 8:41

Great I think an update is indeed very welcome and needed.
But we also know that it's very difficult to keep it up to date.

I think the wiki is handier then a pdf.
But markdown on github is definitely better then a pdf.

User avatar
mlamie
Posts: 150
Joined: Friday 25 October 2013 17:12
Target OS: Raspberry Pi
Domoticz version: 3.5877
Location: The Netherlands
Contact:

Re: I'm considering updating the manual

Post by mlamie » Saturday 07 October 2017 10:57

The PDF is indeed outdated and maintaining the documentation always a good idea. I did some rework on the wiki some time ago and I started to plot the content of the wiki and pdf manual in a mind map. https://www.mindmeister.com/nl/57717697 ... iki-manual

We also listed all wiki pages in an excel https://docs.google.com/spreadsheets/d/ ... 1989169120

Might be a good starting point to work with ;-)
Raspberry Pi 3, RaZberry, RFXtrx433
Various Z-Wave devices, KlikAanKlikUit devices, ESP8266 NodeMCU, Sonoff POW and a Essent E-thermostaat
IP camera: Dahua 4MP IPC-HDBW4421R-AS, Vivotek FD8134V

Kkmcbf
Posts: 1
Joined: Tuesday 17 November 2015 18:24
Target OS: NAS (Synology & others)
Domoticz version:
Contact:

Re: I'm considering updating the manual

Post by Kkmcbf » Monday 09 October 2017 7:54

mlamie wrote:The PDF is indeed outdated and maintaining the documentation always a good idea. I did some rework on the wiki some time ago and I started to plot the content of the wiki and pdf manual in a mind map. https://www.mindmeister.com/nl/57717697 ... iki-manual

We also listed all wiki pages in an excel https://docs.google.com/spreadsheets/d/ ... 1989169120

Might be a good starting point to work with ;-)
@mlamie Very good work.
Thanks very much

Enviado desde mi PLK-L01 mediante Tapatalk


digimate
Posts: 26
Joined: Tuesday 02 February 2016 21:20
Target OS: Raspberry Pi
Domoticz version: lastbeta
Contact:

Re: I'm considering updating the manual

Post by digimate » Monday 09 October 2017 8:56

@mack

Yes, please update the manual. I will be grateful to you.

Best Regards!
Synology DS716+. Domotica devices (on about 30): KaKu (and other 433MHz devices), Z-Wave, Mi-Light, Xiaomi.

User avatar
mack
Posts: 27
Joined: Friday 08 April 2016 8:23
Target OS: Raspberry Pi
Domoticz version: Stable
Location: Dallas, USA
Contact:

Re: I'm considering updating the manual

Post by mack » Thursday 12 October 2017 4:31

mlamie wrote:
Saturday 07 October 2017 10:57
We also listed all wiki pages in an excel https://docs.google.com/spreadsheets/d/ ... 1989169120

Might be a good starting point to work with ;-)
I sent a request for permission to view the spreadsheet through my gmail address. There was no place to include a note explaining who it was requesting access. Given my location listed here on the forum is Dallas, you can probably figure which request is mine.

User avatar
Westcott
Posts: 547
Joined: Tuesday 09 December 2014 18:04
Target OS: Raspberry Pi
Domoticz version: Beta
Location: UK - Glos
Contact:

Re: I'm considering updating the manual

Post by Westcott » Thursday 12 October 2017 10:33

Zwave - Sigma Z+ stick, Fibaro 2x FGSD002, FGMS001
Horstmann - 2x HRT4, 2x C-stat-11, 4x ASR-ZW, TKB 2x TZ56, 2x TZ68E
Max-EQ Cube, Valve, Neo 2x door
RFXtrx433E, RFlink - 1byone driveway, doorbell, Oregon and BangGood temp
Wifi - YeeLight RGB, 3x ESP8266

User avatar
mlamie
Posts: 150
Joined: Friday 25 October 2013 17:12
Target OS: Raspberry Pi
Domoticz version: 3.5877
Location: The Netherlands
Contact:

Re: I'm considering updating the manual

Post by mlamie » Thursday 12 October 2017 13:44

mack wrote:
Thursday 12 October 2017 4:31
I sent a request for permission to view the spreadsheet through my gmail address. There was no place to include a note explaining who it was requesting access. Given my location listed here on the forum is Dallas, you can probably figure which request is mine.
Permissions granted!
Raspberry Pi 3, RaZberry, RFXtrx433
Various Z-Wave devices, KlikAanKlikUit devices, ESP8266 NodeMCU, Sonoff POW and a Essent E-thermostaat
IP camera: Dahua 4MP IPC-HDBW4421R-AS, Vivotek FD8134V

User avatar
mack
Posts: 27
Joined: Friday 08 April 2016 8:23
Target OS: Raspberry Pi
Domoticz version: Stable
Location: Dallas, USA
Contact:

Re: I'm considering updating the manual

Post by mack » Wednesday 18 October 2017 4:38

I've been thinking about this more. It would be nice to just have everything in the wiki so the wiki editors would possibly be persuaded to update some of the more strict "manual" parts. However, as it is, the wiki typically documents the development branch when it's updated. I think someone who would be looking for something called "Manual" would be a newcomer and might more often choose Stable over Beta to try out.

For that main reason, I think github might be the better place for a manual so that Stable can have a manual to match, and the updates to the manual can be reviewed in the development branch.

Any thoughts from possible contributors to the manual?

User avatar
mack
Posts: 27
Joined: Friday 08 April 2016 8:23
Target OS: Raspberry Pi
Domoticz version: Stable
Location: Dallas, USA
Contact:

Re: I'm considering updating the manual

Post by mack » Saturday 28 October 2017 5:24

Since I've gotten no feedback regarding this, I'm going to move forward. I think the best solution is to consolidate everything into the wiki and tagging features that are only available in beta versions. I'm not experienced with wiki editing, so don't expect lightning speed or anything :)

User avatar
mlamie
Posts: 150
Joined: Friday 25 October 2013 17:12
Target OS: Raspberry Pi
Domoticz version: 3.5877
Location: The Netherlands
Contact:

Re: I'm considering updating the manual

Post by mlamie » Sunday 29 October 2017 22:38

mack wrote:
Saturday 28 October 2017 5:24
Since I've gotten no feedback regarding this, I'm going to move forward. I think the best solution is to consolidate everything into the wiki and tagging features that are only available in beta versions. I'm not experienced with wiki editing, so don't expect lightning speed or anything :)
Hi Mack, it might be an idea to label the wiki pages/sections with BETA, but that will mean we need to review these pages each time after a stable release.

Labeling now is done with mediawiki Categories see also: http://domoticz.com/wiki/Special:Categories
Raspberry Pi 3, RaZberry, RFXtrx433
Various Z-Wave devices, KlikAanKlikUit devices, ESP8266 NodeMCU, Sonoff POW and a Essent E-thermostaat
IP camera: Dahua 4MP IPC-HDBW4421R-AS, Vivotek FD8134V

User avatar
mack
Posts: 27
Joined: Friday 08 April 2016 8:23
Target OS: Raspberry Pi
Domoticz version: Stable
Location: Dallas, USA
Contact:

Re: I'm considering updating the manual

Post by mack » Monday 30 October 2017 0:00

mlamie wrote:
Sunday 29 October 2017 22:38
but that will mean we need to review these pages each time after a stable release.
I was hoping to get the wiki admin to install Scribunto or other standard scripting extension so that tags would only be applied as needed :D

leecollings
Posts: 120
Joined: Tuesday 30 June 2015 18:09
Target OS: Raspberry Pi
Domoticz version:
Location: United Kingdom
Contact:

Re: I'm considering updating the manual

Post by leecollings » Wednesday 01 November 2017 18:07

Personally, I think a 'docs' subdomain, and a website with the manual on would be the best way to go.

IT can easily be mobile viewable, and responsive to be able to read on any device, can be updated easily. etc.

JeanChristophe
Posts: 19
Joined: Tuesday 18 April 2017 19:21
Target OS: Raspberry Pi
Domoticz version:
Contact:

Re: I'm considering updating the manual

Post by JeanChristophe » Sunday 05 November 2017 16:05

You can count on me to help.
leecollings wrote:
Wednesday 01 November 2017 18:07
Personally, I think a 'docs' subdomain, and a website with the manual on would be the best way to go.
I agree.

If the manual is easily editable (wiki, for instance), I think you will gain in response time when a change is made in Domoticz.

For my point a view, the actual wiki is a good source of information, but is is not a manual.

I would be glad if we could have a reference document. The actual wiki is to volatil to be used as a manual (but I repeat, it is very good source of information).

Post Reply

Who is online

Users browsing this forum: Denny64 and 3 guests