On 27/09/12 15:38, anonym wrote:
> 27/09/12 15:19, intrigeri wrote:
>> hi,
>>
>> anonym wrote (27 Sep 2012 13:09:17 GMT) :
>>> doc/encryption_and_privacy/openpgp_passphrase_encryption (symmetric)
>>> --------------------------------------------------------------------
>>
>>> The context menu for gpgApplet is now different, so both screenshots
>>> (encryption and decryption) have to be updated.
>>
>> While we're at it, we could drop screenshots (as adviced by GNOME
>> documentation guidelines, that some of us found very inspiring) and
>> get rid of this problem.
>
> At first I intuitively felt strongly opposed to this, but after reading
> the relevant part of GNOME-STYLE [1] and thinking some about this, I now
> agree. I still think we should keep the screenshot for locating the
> applet, though.
>
> [1]
> http://developer.gnome.org/gdp-style-guide/stable/infodesign-8.html.en#infodesign-10
Exactly. We should try to limit the number of screenshot but not remove
not all of them. For example, we should keep the ones who explain where
is the applet, and what it looks like.
>>> doc/encryption_and_privacy/openpgp_with_gedit (asymmetric)
>>> ----------------------------------------------------------
>>
>>> This page should be renamed since gpgApplet is to be used, not gedit.
>>> Perhaps "openpgp_public_key" is a better name.
>>
>> The symmetric one is called "openpgp_passphrase_encryption", so
>> perhaps we want to have this one contain "_encryption" too?
>
> Sure. Let's say "openpgp_public_key_encryption" then.
That's what I was going to propose.
>>> Actually there may be a point in uniting these pages into a single
>>> one now since the same tool is used in both cases. Thoughts?
>>
>> I'm not sure "the same tool is used" is a good criterion for deciding
>> how we organize end-user documentation.
>>
>> These are pretty different usecases, probably targetting quite
>> different people, so I'd rather keep separate (shorter) pages.
>>
>> E.g. some people use symmetric encryption, and don't even know any
>> other kind of encryption exists, so pointing them to a page where both
>> are documented may be an additional factor of confusion. Keeping these
>> pages separate also makes it easier to link to the one or the other.
>
> You may be right. OTOH, some parts will be (largely) duplicated, like
> how to find the applet in the notification area, the explanation that
> gpgApplet operates on the clipboard, and how to decrypt/verify stuff.
I agree with intrigeri. Those should be separate pages. In case parts
are really duplicated, I sometimes use inline directives to factorize
the common parts in a small dummy page. See:
/doc/first_steps/manual_usb_installation.intro/
/doc/first_steps/manual_usb_installation/
/doc/first_steps/manual_usb_installation/linux/
Feel free to comment…
Regarding my commitment to doing that. I really want to do it. I'm
pretty busy there days but I'll try to work on that on Friday, and Saturday.
This project is more motivating than ever, but the pace of releases is
really hard for me to cope with :(
