Writing tips for easy reading - Revision history

38.34.69.190 at 14:45, 27 May 2021

2021-05-27T14:45:01Z

← Older revision		Revision as of 14:45, 27 May 2021
Line 74:		Line 74:
	** Side effects		** Side effects

	* Use [roman numerals ~~or numbers~~ when mentioning the phase of a clinical trial (ex. Phase III).		* Use roman numerals when mentioning the phase of a clinical trial (ex. Phase III).
	* Avoid starting a sentence with a number (i.e., instead of “55 people were included in the study”, write “The study included 55 people”).		* Avoid starting a sentence with a number (i.e., instead of “55 people were included in the study”, write “The study included 55 people”).
	* Numbers nine and below should be written out, while numbers above nine should be written as numerals (ex. “He had three cats.” vs “She had eleven fish.”)		* Numbers nine and below should be written out, while numbers above nine should be written as numerals (ex. “He had three cats.” vs “She had eleven fish.”)

139.130.21.78: /* 4) Miscellaneous */

2021-05-27T11:19:22Z

4) Miscellaneous

← Older revision		Revision as of 11:19, 27 May 2021
Line 61:		Line 61:
	== Technical Writing Tips ==		== Technical Writing Tips ==

	=== ~~'''~~1. Spelling~~'''~~ ===		=== 1. Spelling ===

	* Use American spelling. Commonly misspelled words:		* Use American spelling. Commonly misspelled words:
Line 79:		Line 79:
	** Exception: All numbers should be written as numerals when associated with a unit of measure (ex. “His cat weighed 8 lbs.”)		** Exception: All numbers should be written as numerals when associated with a unit of measure (ex. “His cat weighed 8 lbs.”)

	=== ~~'''~~2. Punctuation~~'''~~ ===		=== 2. Punctuation ===

	* Use the oxford/serial comma (ex. Rapamycin has been shown to extend the healthy lifespan in worms, yeast, flies, and mice).		* Use the oxford/serial comma (ex. Rapamycin has been shown to extend the healthy lifespan in worms, yeast, flies, and mice).
Line 86:		Line 86:
	* Figure titles/captions should have proper punctuation.		* Figure titles/captions should have proper punctuation.

	=== ~~'''~~3. Formatting~~'''~~ ===		=== 3. Formatting ===

	* The reference should come after the period.		* The reference should come after the period.
Line 95:		Line 95:
	* Use a comma (not a space) in numbers larger than 1000 (i.e. “25,700”)		* Use a comma (not a space) in numbers larger than 1000 (i.e. “25,700”)

	=== ~~'''~~4~~) Miscellaneous'''~~ ===		=== 4. Miscellaneous ===

	* Use patient-centric language (i.e., instead of “Schizophrenic people often have impaired cognition”, say “People with schizophrenia often have impaired cognition”)		* Use patient-centric language (i.e., instead of “Schizophrenic people often have impaired cognition”, say “People with schizophrenia often have impaired cognition”)
	** Other examples: diabetics, obese people		** Other examples: diabetics, obese people

139.130.21.78: /* 2) Punctuation */

2021-05-27T11:18:45Z

2) Punctuation

← Older revision		Revision as of 11:18, 27 May 2021
Line 79:		Line 79:
	** Exception: All numbers should be written as numerals when associated with a unit of measure (ex. “His cat weighed 8 lbs.”)		** Exception: All numbers should be written as numerals when associated with a unit of measure (ex. “His cat weighed 8 lbs.”)

	=== '''2~~) Punctuation~~''' ===		=== '''2. Punctuation''' ===
	~~· Use the oxford/serial comma (ex. Rapamycin has been shown to extend the healthy lifespan in worms, yeast, flies, and mice).~~

	· Abbreviated titles should have a period after (i.e., Dr. Jones, Mrs. Jones, Ms. Jones).		* Use the oxford/serial comma (ex. Rapamycin has been shown to extend the healthy lifespan in worms, yeast, flies, and mice).
			* Abbreviated titles should have a period after (i.e., Dr. Jones, Mrs. Jones, Ms. Jones).
			* Bullet points should have a period at the end if they are a complete sentence.
			* Figure titles/captions should have proper punctuation.

	~~· Bullet points should have a period at the end if they are a complete sentence~~.		=== '''3. Formatting''' ===

	~~· Figure titles~~/~~captions should~~ have ~~proper punctuation~~.		* The reference should come after the period.
			* Ensure every image/figure has a caption/description.
			* Define acronyms at first mention (ex. Rapamycin was approved by the US Food and Drug Administration (FDA) in 1994).
			* Ensure there is a space between the number and unit of measurement (ex. 5 mL, 27 IU/kg)
			* Ensure there is a space between the greater than/less than symbol and the number (ex. “People with diabetes have a fasting plasma glucose level ≥ 7.0 mmol/L”)
			* Use a comma (not a space) in numbers larger than 1000 (i.e. “25,700”)

	'''3) ~~Formatting~~'''		=== '''4) Miscellaneous''' ===

	~~· The reference should come after the period.~~		* Use patient-centric language (i.e., instead of “Schizophrenic people often have impaired cognition”, say “People with schizophrenia often have impaired cognition”)
			** Other examples: diabetics, obese people
	~~· Ensure every image/figure has a caption/description.~~

	~~· Define acronyms at first mention (ex. Rapamycin was approved by the US Food and Drug Administration (FDA) in 1994).~~

	~~· Ensure there is a space between the number and unit of measurement (ex. 5 mL, 27 IU/kg)~~

	~~· Ensure there is a space between the greater than/less than symbol and the number (ex. “People with diabetes have a fasting plasma glucose level ≥ 7.0 mmol/L”)~~

	~~· Use a comma (not a space) in numbers larger than 1000 (i.e. “25,700”)~~

	~~'''4) Miscellaneous'''~~

	· Use patient-centric language (i.e., instead of “Schizophrenic people often have impaired cognition”, say “People with schizophrenia often have impaired cognition”)

	o Other examples: diabetics, obese people

139.130.21.78 at 11:16, 27 May 2021

2021-05-27T11:16:49Z

@@ Line 1: / Line 1: @@
 We like the content on Longevity Wiki to be easy to understand. Here are 3 writing tips from the field of '''User Experience (UX)''' that can help you when writing an article:
-== 1. Keep in mind the target audience ==
+=== 1. Keep in mind the target audience ===
 The target audience for the Longevity Wiki is pretty big: from people with only a high school education who are interested in health to seasoned biomedical researchers with a Ph.D. By making sure your article is '''not too complex''', all readers will be able to understand it.
 The maximum difficulty level you should aim for is '''similar to that of Wikipedia'''. It’s ok to explain concepts in detail, but you don’t want to go as deep as in a scientific journal article. Furthermore, we prefer plain language over jargon and simple sentences over complex ones.
-== 2. Support scanning ==
+=== 2. Support scanning ===
 UX research has shown that people online primarily scan, rather than read. You can support this behaviour by doing the following in your article:
@@ Line 14: / Line 54: @@
 * '''Use plain language''' to keep content concise and clear
-== 3. Use specific link labels ==
+=== 3. Use specific link labels ===
 If you include links in your article, making them specific will help with the findability, scannability and accessibility of the content. Your link label should '''set up an accurate expectation''' of where the user is going. For example, instead of writing: ‘To learn more about Rapamycin, [[Rapamycin|click here]]’, write ‘Learn more about [[Rapamycin]]’.
 '''More UX writing tips''' can be found at the [https://www.nngroup.com/topic/writing-web/ Nielsen Norman Group].

MarcS: This is the first version of the page. It contains a number of UX writing tips for writing easy to understand articles.

2021-05-22T08:45:09Z

This is the first version of the page. It contains a number of UX writing tips for writing easy to understand articles.

New page

We like the content on Longevity Wiki to be easy to understand. Here are 3 writing tips from the field of '''User Experience (UX)''' that can help you when writing an article:

== 1. Keep in mind the target audience ==
The target audience for the Longevity Wiki is pretty big: from people with only a high school education who are interested in health to seasoned biomedical researchers with a Ph.D. By making sure your article is '''not too complex''', all readers will be able to understand it.

The maximum difficulty level you should aim for is '''similar to that of Wikipedia'''. It’s ok to explain concepts in detail, but you don’t want to go as deep as in a scientific journal article. Furthermore, we prefer plain language over jargon and simple sentences over complex ones.

== 2. Support scanning ==
UX research has shown that people online primarily scan, rather than read. You can support this behaviour by doing the following in your article:

* '''Use clear, noticeable headings and subheadings''' to break up content and label sections so that people can scan to find what they’re most interested in
* '''Place information up front''' (also called “front-loading”) in the structure of your content, as well as in subheadings and links, to allow people to understand the message quickly while scanning
* '''Use formatting techniques like bold text and bulleted lists''' to allow the eye to focus on the most important information
* '''Use plain language''' to keep content concise and clear

== 3. Use specific link labels ==
If you include links in your article, making them specific will help with the findability, scannability and accessibility of the content. Your link label should '''set up an accurate expectation''' of where the user is going. For example, instead of writing: ‘To learn more about Rapamycin, [[Rapamycin|click here]]’, write ‘Learn more about [[Rapamycin]]’.

'''More UX writing tips''' can be found at the [https://www.nngroup.com/topic/writing-web/ Nielsen Norman Group].