Help:Contributing/styleGuide - Revision history

Rongzhou at 18:16, 19 August 2026

2026-08-19T18:16:48Z

← Older revision		Revision as of 18:16, 19 August 2026
Line 16:		Line 16:

	[[Cheatsheets:SPARQL\|Technical documentation example: cheatsheet]]		[[Cheatsheets:SPARQL\|Technical documentation example: cheatsheet]]

			[[Cheatsheets:Markdown\|Technical documentation example: cheatsheet 2]]

Rongzhou at 14:10, 19 August 2026

2026-08-19T14:10:17Z

← Older revision		Revision as of 14:10, 19 August 2026
Line 7:		Line 7:
	== Presentation ==		== Presentation ==

	# Show, don't tell. Rather than writing at length about what a config does, show in a ~~sandbox~~ example the results.		# Show, don't tell. Rather than writing at length about what a config does, show a real-world code example with the results.
	# Use tables for comparison.		# Use tables for comparison.
	# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?		# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?

Rongzhou at 14:07, 19 August 2026

2026-08-19T14:07:21Z

← Older revision		Revision as of 14:07, 19 August 2026
Line 15:		Line 15:
	Some good examples		Some good examples

	[[Cheatsheets:SPARQL\|Technical documentation example]]		[[Cheatsheets:SPARQL\|Technical documentation example: cheatsheet]]

Rongzhou at 12:41, 19 August 2026

2026-08-19T12:41:35Z

← Older revision		Revision as of 12:41, 19 August 2026
Line 1:		Line 1:
	== ~~language~~ style ==		== Language style ==

	# Get straight to the point. No word padding. Good writers express their best ideas in the least amount of words.		# Get straight to the point. No word padding. Good writers express their best ideas in the least amount of words.
Line 5:		Line 5:
	# Use proper vocabulary. Do not use complex words to show off, but also do not oversimplify risking ambiguity.		# Use proper vocabulary. Do not use complex words to show off, but also do not oversimplify risking ambiguity.

	== ~~presentation~~ ==		== Presentation ==

	# Show, don't tell. Rather than writing at length about what a config does, show in a sandbox example the results.		# Show, don't tell. Rather than writing at length about what a config does, show in a sandbox example the results.
Line 11:		Line 11:
	# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?		# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?

	== ~~turn~~ advice into action ==		== Turn advice into action ==

	Some good examples		Some good examples

	[[Cheatsheets:SPARQL\|Technical documentation example]]		[[Cheatsheets:SPARQL\|Technical documentation example]]

Rongzhou: /* turn advice into action */

2026-08-19T12:22:49Z

turn advice into action

← Older revision		Revision as of 12:22, 19 August 2026
Line 15:		Line 15:
	Some good examples		Some good examples

	[[Cheatsheets:SPARQL ~~technical~~ documentation example]]		[[Cheatsheets:SPARQL\|Technical documentation example]]

Rongzhou at 12:21, 19 August 2026

2026-08-19T12:21:37Z

← Older revision		Revision as of 12:21, 19 August 2026
Line 10:		Line 10:
	# Use tables for comparison.		# Use tables for comparison.
	# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?		# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?

			== turn advice into action ==

			Some good examples

			[[Cheatsheets:SPARQL technical documentation example]]

Rongzhou at 07:30, 19 August 2026

2026-08-19T07:30:06Z

← Older revision		Revision as of 07:30, 19 August 2026
Line 1:		Line 1:
	== language style ==		== language style ==

	# Get straight to the point. No word padding. Good writers express their best ideas in the least amount of words;		# Get straight to the point. No word padding. Good writers express their best ideas in the least amount of words.
	# Long sentences with complex structures are hard to read. Prefer a few shorter sentences than one long one with multiple sub-clauses;		# Long sentences with complex structures are hard to read. Prefer a few shorter sentences than one long one with multiple sub-clauses.
	# Use proper vocabulary. Do not use complex words to show off, but also do not oversimplify risking ambiguity.		# Use proper vocabulary. Do not use complex words to show off, but also do not oversimplify risking ambiguity.

	== presentation ==		== presentation ==

	# Show, don't tell. Rather than writing at length about what a config does, show in a sandbox example the results;		# Show, don't tell. Rather than writing at length about what a config does, show in a sandbox example the results.
	# Use tables for comparison;		# Use tables for comparison.
	# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?		# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?

Rongzhou at 07:29, 19 August 2026

2026-08-19T07:29:38Z

← Older revision		Revision as of 07:29, 19 August 2026
Line 1:		Line 1:
	== language style ==		== language style ==

	# Get straight to the point. No word padding.		# Get straight to the point. No word padding. Good writers express their best ideas in the least amount of words;
	# ~~Use short sentences whenever possible.~~ Long sentences with complex structures are hard to read.		# Long sentences with complex structures are hard to read. Prefer a few shorter sentences than one long one with multiple sub-clauses;
	# Use proper vocabulary. Do not use complex words to show off, but also do not oversimplify risking ambiguity		# Use proper vocabulary. Do not use complex words to show off, but also do not oversimplify risking ambiguity.

	== presentation ==		== presentation ==

	# Show, don't tell. Rather than writing at length about what a config does, show in a sandbox example the results.		# Show, don't tell. Rather than writing at length about what a config does, show in a sandbox example the results;
	# Use tables for comparison		# Use tables for comparison;
	# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?		# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?

Rongzhou: 1st draft

2026-08-19T07:11:07Z

1st draft

New page

== language style ==

# Get straight to the point. No word padding.
# Use short sentences whenever possible. Long sentences with complex structures are hard to read.
# Use proper vocabulary. Do not use complex words to show off, but also do not oversimplify risking ambiguity

== presentation ==

# Show, don't tell. Rather than writing at length about what a config does, show in a sandbox example the results.
# Use tables for comparison
# Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?