Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 1 Jan 2024 02:36:33 +0100
From:      Kolusion K <kolusion@post.com>
To:        freebsd-doc@freebsd.org
Subject:   Inconsistent use of both flow of wording and terminology
Message-ID:  <trinity-5842511c-381d-40a7-9936-00977e4529d6-1704072992861@msvc-mesg-gmxus010>

next in thread | raw e-mail | index | archive | help
Hi,


The FreeBSD Handbook inconsistently uses both the flow of wording and terminology when giving instructions. When I say the flow of wording, I mean syntax.

Section 20.12.2. Setting Quota Limits states "To verify that quotas are enabled, run:".

Section 20.13.1. Disk Encryption with gbde states "FreeBSD provides a kernel module for gbde which can be loaded with this command:".

Section 20.14.1. Configuring Encrypted Swap states "To overwrite the current swap partition with random garbage, execute the following command:".

'run', 'with this command', 'execute the following command'...

I think flow of wording should be used consistently because it helps users psychologically interpreting instructions more easily as they become more familiar and habitual with a consistent flow.

I think terminology should be used consistently because some users may think for example that running and executing are two different things.

And I think consistent use of both flow of wording and terminology makes the FreeBSD Handbook look more polished.


I think 'run' is a better term than 'execute' because 'run' is a term used a lot more by people, especially verbally. And 'run' sounds a lot less nerdy than 'execute'. :)


Sincerely,

Kolusion



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?trinity-5842511c-381d-40a7-9936-00977e4529d6-1704072992861>