<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p>Yes - it is actually an example where the feature is already
quite documented. Just not in the manual.</p>
<p>It is one of the better cases, when it comes to documentation.<br>
</p>
<p>Andreas<br>
</p>
<div class="moz-cite-prefix">Am 16.01.19 um 16:07 schrieb Marco
Bernasocchi:<br>
</div>
<blockquote type="cite"
cite="mid:db3d876e-6ceb-5bf2-7d5c-760cf6ae23c7@opengis.ch">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<p>Well to be fair, in this (and many) other cases, the "Naughty
Dev" provided an amazingly well written description of the
feature. That can just be copy pasted to the docs.</p>
<p>But yes, I think minimal docs, or maybe a changelog entry or a
link to a blogpost would be good<br>
</p>
<p>Cheers</p>
<p>Marco<br>
</p>
<p><br>
</p>
<div class="moz-cite-prefix">On 16.01.19 14:39, Alexandre Neto
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:CA+H0G_HXP=Pb6nfrmhW+GUkvOVEO8YWWV3vu4rnU3A1GPSuEUQ@mail.gmail.com">
<meta http-equiv="content-type" content="text/html;
charset=UTF-8">
<div dir="ltr">
<div>
<div>
<div>+1 <br>
</div>
<div><br>
</div>
<div>No more "the naughty developer didn't provide a
description" messages, please. </div>
<br>
</div>
Best regards,<br>
<br>
</div>
Alexandre Neto<br>
</div>
<br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">Paolo Cavallini <<a
href="mailto:cavallini@faunalia.it" moz-do-not-send="true">cavallini@faunalia.it</a>>
escreveu no dia quarta, 16/01/2019 às 09:02:<br>
</div>
<blockquote class="gmail_quote" style="margin:0 0 0

.8ex;border-left:1px #ccc solid;padding-left:1ex">Totally
agreed:<br>
* pushing at least a minimal documentation has to be a
requirement, just<br>
like unit tests<br>
* an automatic system is far preferable to a manual one.<br>
Topic added to the TODO for the HF:<br>
<a
href="https://github.com/qgis/QGIS/wiki/22nd-Developer-Meeting-in-A-Coru%C3%B1a,-Spain"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://github.com/qgis/QGIS/wiki/22nd-Developer-Meeting-in-A-Coru%C3%B1a,-Spain</a><br>
Thanks.<br>
<br>
On 16/01/19 09:14, Andreas Neumann wrote:<br>
> Hi Richard,<br>
> <br>
> It is something to consider - I agree that we have a
documentation crisis.<br>
> <br>
> On the other hand - I never see any QGIS user
reading/consulting that<br>
> manual we provide (because it is hard to read a manual)
- that's why I<br>
> sometimes - if a question from a user about feature x
is raised - I<br>
> don't answer directly but point to the chapter in the
manual - just to<br>
> show users, that they should first read that manual,
then Google and<br>
> consult stack exchange and then only ask if the other
information<br>
> sources don't help. Or attend a course ...<br>
> <br>
> Perhaps there are also other forms to consider besides
the manual to<br>
> reveal hidden features?<br>
> <br>
> The visual changelog is a good resource to find out
about new and hidden<br>
> features - but even that is often only a title and no
text and screenshot.<br>
> <br>
> Let's discuss it in A Coruna at the meeting. Perhaps we
should try your<br>
> proposal, even if I expect some resistance from some
devs/customers.<br>
> <br>
> Greetings,<br>
> Andreas<br>
> <br>
> Am 16.01.19 um 08:42 schrieb Richard Duivenvoorde:<br>
>> Hi Devs,<br>
>><br>
>> As I see we are in a "Documentation crisis" and
seeing the comment below<br>
>> in a discussion (please do not take this
personal!!!):<br>
>><br>
>> """<br>
>> No. From my side it's no documentation PR planned
at the moment. Feel<br>
>> free to do something and to take the stuff from my
blogpost.<br>
>> """<br>
>><br>
>> I think our project has to do something. Even
throwing money at people<br>
>> (we did as PSC!) does not help...<br>
>><br>
>> I'm really afraid QGIS will end up with a lot of
HIDDEN features and<br>
>> possibilities. A lot of it's functionality is
hiding because it isn't<br>
>> mentioned in the QGIS docs or blogs (maybe in other
(company) blogs),<br>
>> but only in the code ...<br>
>><br>
>> I do not want to be a PITA, but can we maybe add a
mandatory requirement<br>
>> for a pull request that in case of a new feature
the dev adds some<br>
>> mandatory Text and Images about the feature IN the
PR?<br>
>><br>
>> He/she can also ask a community member to do that
by giving some<br>
>> interview.<br>
>><br>
>> It is really NO fun for doc writers to find a
[FEATURE] issue in the doc<br>
>> writing issues list. He/she has to start guessing
how it was<br>
>> implemented, try it out, or google for some
blogpost or start talking to<br>
>> the dev etcetc. Really NO fun if you want to work
on the documenation<br>
>> because it takes so much time!<br>
>><br>
>> I think implementing developer is just the best
person to write one or<br>
>> two paragraphs (and add some images, hey he has
also tested during<br>
>> coding isn't it?).<br>
>> In this way doc writing could then be just 'copy
and paste' the text, do<br>
>> some grammar fixes and add images from the PR of
the dev in the docs.<br>
>><br>
>> I know a project like MapProxy handles it's PR's
even more rigid: if<br>
>> Documentation is not part of the code PR, it is
just nog pulled. It is<br>
>> easier there because they have text only docs IN
the src tree; that is<br>
>> why I propose to do only text + images.<br>
>><br>
>> I know this is an old idea, but seeing one dev
asking about already<br>
>> implemented features to another dev was the drop...<br>
>> And I'm aware that you cannot prevent this
anyway.... as nobody likes to<br>
>> RTFM :-)<br>
>><br>
>> Regards,<br>
>><br>
>> Richard Duivenvoorde<br>
>><br>
>><br>
>> -------- Forwarded Message --------<br>
>> Subject: Re: [qgis/QGIS-Enhancement-Proposals]
Translation of .qgs<br>
>> project files (#90)<br>
>> Date: Tue, 15 Jan 2019 12:28:40 -0800<br>
>><br>
>> ...<br>
>><br>
>> No. From my side it's no documentation PR planned
at the moment. Feel<br>
>> free to do something and to take the stuff from my
blogpost.<br>
>><br>
>> —<br>
>> You are receiving this because you are subscribed
to this thread.<br>
>> Reply to this email directly, view it on GitHub<br>
>> <<a
href="https://github.com/qgis/QGIS-Enhancement-Proposals/issues/90#issuecomment-454539249"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://github.com/qgis/QGIS-Enhancement-Proposals/issues/90#issuecomment-454539249</a>><br>
>><br>
>><br>
>><br>
>> _______________________________________________<br>
>> QGIS-Developer mailing list<br>
>> <a href="mailto:QGIS-Developer@lists.osgeo.org"
target="_blank" moz-do-not-send="true">QGIS-Developer@lists.osgeo.org</a><br>
>> List info: <a
href="https://lists.osgeo.org/mailman/listinfo/qgis-developer"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a><br>
>> Unsubscribe: <a
href="https://lists.osgeo.org/mailman/listinfo/qgis-developer"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a><br>
> _______________________________________________<br>
> QGIS-Developer mailing list<br>
> <a href="mailto:QGIS-Developer@lists.osgeo.org"
target="_blank" moz-do-not-send="true">QGIS-Developer@lists.osgeo.org</a><br>
> List info: <a
href="https://lists.osgeo.org/mailman/listinfo/qgis-developer"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a><br>
> Unsubscribe: <a
href="https://lists.osgeo.org/mailman/listinfo/qgis-developer"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a><br>
<br>
-- <br>
Paolo Cavallini - <a href="http://www.faunalia.eu"
rel="noreferrer" target="_blank" moz-do-not-send="true">www.faunalia.eu</a><br>
<a href="http://QGIS.ORG" rel="noreferrer" target="_blank"
moz-do-not-send="true">QGIS.ORG</a> Chair:<br>
<a
href="http://planet.qgis.org/planet/user/28/tag/qgis%20board/"
rel="noreferrer" target="_blank" moz-do-not-send="true">http://planet.qgis.org/planet/user/28/tag/qgis%20board/</a><br>
_______________________________________________<br>
QGIS-Developer mailing list<br>
<a href="mailto:QGIS-Developer@lists.osgeo.org"
target="_blank" moz-do-not-send="true">QGIS-Developer@lists.osgeo.org</a><br>
List info: <a
href="https://lists.osgeo.org/mailman/listinfo/qgis-developer"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a><br>
Unsubscribe: <a
href="https://lists.osgeo.org/mailman/listinfo/qgis-developer"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a></blockquote>
</div>
-- <br>
<div dir="ltr" class="gmail_signature"
data-smartmail="gmail_signature">
<div dir="ltr">
<div>Alexandre Neto</div>
<div>---------------------</div>
<div>@AlexNetoGeo</div>
<div><a href="http://sigsemgrilhetas.wordpress.com"
moz-do-not-send="true">http://sigsemgrilhetas.wordpress.com</a></div>
<a href="http://gisunchained.wordpress.com"
moz-do-not-send="true">http://gisunchained.wordpress.com</a><br>
</div>
</div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<pre class="moz-quote-pre" wrap="">_______________________________________________
QGIS-Developer mailing list
<a class="moz-txt-link-abbreviated" href="mailto:QGIS-Developer@lists.osgeo.org" moz-do-not-send="true">QGIS-Developer@lists.osgeo.org</a>
List info: <a class="moz-txt-link-freetext" href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a>
Unsubscribe: <a class="moz-txt-link-freetext" href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a></pre>
</blockquote>
<div class="moz-signature">-- <br>
<meta http-equiv="content-type" content="text/html;
charset=UTF-8">
<div class="moz-signature">
<title></title>
<div class="moz-signature"> <span style="text-align:
left;
 color: #000000; font-family: 'Verdana',
sans-serif;
 font-size: 10pt">Marco Bernasocchi</span><br>
<span style="text-align: left; color: #000000;
font-family:
 'Verdana', sans-serif; font-size: 10pt">QGIS.org
Co-chair</span><br>
<a href="mailto:marco@opengis.ch" target="_blank"
moz-do-not-send="true"> <span style="text-align: left;
color: #000000; font-family:
 'Verdana', sans-serif;
font-size: 8pt">marco@opengis.ch</span> </a><br>
<span style="text-align: left; color: #000000;
font-family:
 'Verdana', sans-serif; font-size: 8pt"><a
href="tel:+41794672470" moz-do-not-send="true">+41 (0)79
467 24 70</a></span><br>
<div><br>
<a href="https://www.opengis.ch" moz-do-not-send="true"> <img
moz-do-not-send="false"
src="cid:part23.D8AC5FF4.2AD2521F@carto.net"
alt="OPENGIS.ch Logo" class="" width="200" height="80"></a>
</div>
</div>
</div>
</div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<pre class="moz-quote-pre" wrap="">_______________________________________________
QGIS-Developer mailing list
<a class="moz-txt-link-abbreviated" href="mailto:QGIS-Developer@lists.osgeo.org">QGIS-Developer@lists.osgeo.org</a>
List info: <a class="moz-txt-link-freetext" href="https://lists.osgeo.org/mailman/listinfo/qgis-developer">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a>
Unsubscribe: <a class="moz-txt-link-freetext" href="https://lists.osgeo.org/mailman/listinfo/qgis-developer">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a></pre>
</blockquote>
</body>
</html>