Problem/Motivation

Our code documentation should be presented in a professional formal manner. These are not conversations, rather directions/instructions/requirements.

This is especially true for Doxygen.

We must remember that for a great many of our developers English is their second language.

Let's not make this difficult for them.

A quote from everythingenglishblog.com

Now that we know what a contraction is, we must determine when we should avoid them or use them. The answer lies in the formality of the document that you are preparing. If you are engaged in formal writing, I would suggest that you avoid using all contractions. This includes cover letters, résumés, theses, essays, etc. Because the use of contractions seems more informal, you should avoid them in any instance in which you want to portray a professional, respected image.

Emphasis is mine.

I propose we start with the code documentation (Doxygen) and replace all instances of contractions with the full equivalent.

I.E isn't => is not
And so on.

Contractions and plain English

Benefits

If we adopted this change, the Drupal Project would benefit by ...

Three supporters required

  1. https://www.drupal.org/u/{userid} (yyyy-mm-dd they added support)
  2. https://www.drupal.org/u/{userid} (yyyy-mm-dd they added support)
  3. https://www.drupal.org/u/{userid} (yyyy-mm-dd they added support)

Proposed changes

Provide all proposed changes to the Drupal Coding standards. Give a link to each section that will be changed, and show the current text and proposed text as in the following layout:

1. Drupal API documentation standards (general)

Current text

There is no text about contractions

Proposed text

Avoid the use of contractions.

2. Repeat the above for each page or sub-page that needs to be changed.

Remaining tasks

  1. Create this issue in the Coding Standards queue, using the defined template
  2. Add supporters
  3. Create a Change Record
  4. Review by the Coding Standards Committee
  5. Coding Standards Committee takes action as required
  6. Discussed by the Core Committer Committee, if it impacts Drupal Core
  7. Final review by Coding Standards Committee
  8. Documentation updates
    1. Edit all pages
    2. Publish change record
    3. Remove 'Needs documentation edits' tag
  9. If applicable, create follow-up issues for PHPCS rules/sniffs changes

For a full explanation of these steps see the Coding Standards project page

Comments

cilefen’s picture

Title: Remove usage of contractions in all documentation » [policy] Ban contractions in all documentation

The official style guidelines do not mention contractions. So this issue is a policy discussion.

All documentation and comments should form proper sentences, use proper grammar and punctuation, and generally follow the same style guidelines as Drupal.org content: http://drupal.org/style-guide/content

From https://www.drupal.org/coding-standards/docs#drupal

mbrett5062’s picture

I have read the existing documentation on grammar/style.

I think we need to make a distinction here between formal and informal documentation.

For API and Doxygen I think we should be using a formal style.

Anything else is more of an end user facing manual/directions, these should be informal, inline with current Drupal.org guidelines.

mbrett5062’s picture

Maybe I should change the IS to better reflect this?

cilefen’s picture

Title: [policy] Ban contractions in all documentation » [policy] Ban contractions in code documentation

So it may be more of a suggestion of a formal writing style in the code documentation. A title adjustment should do it. If you can think of a better one, please change it.

cilefen’s picture

Maybe "Adopt a formal writing style in code documentation."

mbrett5062’s picture

Will get to this tomorrow. Pool party in 10 minutes :)

jhodgdon’s picture

Project: Drupal core » Drupal Technical Working Group
Version: 8.1.x-dev »
Component: documentation » Code
Issue tags: +Coding standards

This is a coding standards discussion, so moving to TWG project.

cilefen’s picture

Re: #5, I think this issue should be about a prose standard for code comments.

cilefen’s picture

Re: #5, I think this issue should be about a prose standard for code comments.

mbrett5062’s picture

Issue summary: View changes

Updated the IS to better reflect that this applies to code and API documentation, not for end users, where we have an informal policy in place to be more welcoming.

tizzo’s picture

Project: Drupal Technical Working Group » Coding Standards
Component: Code » Documentation
quietone’s picture

Issue summary: View changes
quietone’s picture

Title: [policy] Ban contractions in code documentation » Ban contractions in code documentation
quietone’s picture

Issue summary: View changes
Status: Active » Needs review

Added a suggestion to avoid the use of contractions.

rkoller’s picture

I am not sure if the categorical avoidance of contractions is the right choice here. First a few additional aspects:

  1. The Drupal User Interface Standards for interface text have already the requirement not to use contractions (https://www.drupal.org/docs/develop/user-interface-standards/interface-text see the last point within the style section)
  2. The Yahoo style guide (Barr 2010: The Yahoo Style Guide) has the recommendation to use contractions with caution. From their point of view readers should know common contractions like it's or she's and some might even understand irregular contractions like let's (let us). While negative contraction, even the simple ones like can't and don't, can easily be misread by people who are only briefly scanning a text. Their recommendation is, for the sake of clarity, in case the information is in particular important, to spell these out (for example, Do not click Buy before you complete the form). While slangy, outdated, or less usual contractions such as ain't, that'll, could've, shan't, 'tis, and the unwieldy shouldn't've should be avoided in general.
  3. Erika Jorgensen takes a similar approach in her book on Strategic Content Design. In the section about plain language she actually advocates for the use of contractions. According to her avoiding contractions is another writing rule that was advocated for long ago by English teachers everywhere. From her perspective this recommendation feels extremely outdated, in particular in the context of digital content. Contractions improve the readability and create a more conversational, friendlier tone for your content. According to her there are only a few reasons to avoid contractions. First, cases where one is writing an amicus briefs or some kind of formal legal documents. Second, cases where one is writing a warning or error message in the context of UX content/micro copy. In these cases it can be considered helpful to avoid contraction entirely, because doing so forces the recipient/reader to slow down a bit and to focus on why the error happened and what the exact next steps are they have to take. The example she provided alongside was: The app did not launch can be more emphatic and clearer than The app didn’t launch. In this particular case, not is the most important word in the sentence and you are doing the reader a favor by writing out did not instead of condensing it into didn’t.

The three links about contractions and plain english in the issue summary are in the same vein like point 2 and 3.
So as I've state in my initial statement, I would be rather hesitant to ban and remove contractions from the documentation entirely. I would try to still allow the usage of contractions but avoid negative contractions and maybe conditional contractions. And as a rule of thumb in situations where you as the writer want to be empathic and extra clear avoid contractions as well (see point 3). That would be sort of the middle ground between completely banning contractions or using contractions for everything. From my perspective it would improve the general readability but at the same time the copy would become more clear in the situations where it is necessary. And on a side note, personally I also disagree for the given reasons with the strict ban of contractions in the Drupal User Interface Guidelines in point 1.

bbrala’s picture

Status: Needs review » Closed (won't fix)

General consensus is not to do this, we have had another month of time to see other opinions. Will close this as won't fix.