← Back to team overview

kicad-developers team mailing list archive

Re: [Kicad-doc-devs] string change proposal

 

Thanks Jeff,

That's 35->13 (2.7x) word reduction or 24->8 (3x) reduction for the less
explicit sentence.

Description text shouldn't be longer than 12-18 words, if it is it needs
rephrasing and/or help reference tag.

On Thu, Feb 8, 2018 at 2:42 AM, Jeff Young <jeff@xxxxxxxxx> wrote:

> > … or "Set default text editor and PDF viewer programs to open files from
> KiCad”
>
> +1
>
>
> On 8 Feb 2018, at 10:15, Andrey Kuznetsov <kandrey89@xxxxxxxxx> wrote:
>
> Wow, that sentence is unnecessarily long.
>
> By rephrasing, you can cut that text in half. Also, why is text editor and
> PDF viewer in the same context? Default text editor and default PDF viewer
> do not open the same files, is this a context for a Group where those 2 are
> defined, weird...
>
> Telling the user that he "may define" a"Default Text Editor" is redundant,
> same for favorite, default is better, that's what is seen across many
> programs, you define a default program to open files, you don't define a
> favorite program. "These settings" redundant because you are in a settings
> editor window, duhh.
>
> How about "Set default text editor and PDF viewer programs"?
>
> If you want to be more explicit: "Set default text editor and PDF viewer
> programs for use by KiCad" or "Set default text editor and PDF viewer
> programs to open files from KiCad"
>
> On Wed, Feb 7, 2018 at 8:23 AM, Andy Peters <devel@xxxxxxxxx> wrote:
>
>>
>>
>> > On Feb 7, 2018, at 5:09 AM, Marco Ciampa <ciampix@xxxxxxxxx> wrote:
>> >
>> > Hello,
>> > I am not a native english,
>>
>> Your English is better than my Italian!
>>
>> > so I think it is better to ask even for small phrases:
>> >
>> > Here:
>> >
>> > #. type: Plain text
>> > #: kicad.adoc:246
>> > msgid ""
>> > "You may define your favorite text editor and PDF viewer. These
>> settings are "
>> > "used whenever you want to open a text or PDF file."
>> >
>> > I would have written it in a more esplicit way like:
>> >
>> > "You may define your favorite text editor and PDF viewer. These
>> settings are "
>> > "used by KiCad whenever you want to open a text or PDF file from the
>> inside "
>> > "of any of the KiCad tools."
>> >
>> > Comments?
>>
>> In general, I’m a fan of being as explicit and clear as possible. But, in
>> this case, I think the user should be aware that s/he’s setting something
>> from within Kicad, and as such that setting is only relevant when
>> interacting with a Kicad tool.
>>
>> -a
>> _______________________________________________
>> Mailing list: https://launchpad.net/~kicad-developers
>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~kicad-developers
>> More help   : https://help.launchpad.net/ListHelp
>>
>
>
>
> --
> Remember The Past, Live The Present, Change The Future
> Those who look only to the past or the present are certain to miss the
> future [JFK]
>
> kandrey89@xxxxxxxxx
> Live Long and Prosper,
> Andrey
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
>
>
>


-- 
Remember The Past, Live The Present, Change The Future
Those who look only to the past or the present are certain to miss the
future [JFK]

kandrey89@xxxxxxxxx
Live Long and Prosper,
Andrey

References