Category:Reference - Revision history

Klinger: make it the same

2024-04-18T20:51:09Z

make it the same

← Older revision		Revision as of 20:51, 18 April 2024
Line 1:		Line 1:
	''Reference'' is one of the five primary resource categories for the wiki.		''Reference'' is one of the five primary [[Resources\|resource]] categories for the wiki.

	Reference guides are technical descriptions of the machinery and how to operate it.		Reference guides are technical descriptions of the machinery and how to operate it.

Klinger: make the first sentence in the five resource categories the same.

2024-04-18T20:50:14Z

make the first sentence in the five resource categories the same.

← Older revision		Revision as of 20:50, 18 April 2024
Line 1:		Line 1:
	Reference is one of the five primary resource categories for the wiki.		''Reference'' is one of the five primary resource categories for the wiki.

	Reference guides are technical descriptions of the machinery and how to operate it.		Reference guides are technical descriptions of the machinery and how to operate it.

Klinger at 20:48, 18 April 2024

2024-04-18T20:48:05Z

← Older revision		Revision as of 20:48, 18 April 2024
Line 1:		Line 1:
			Reference is one of the five primary resource categories for the wiki.

	Reference guides are technical descriptions of the machinery and how to operate it.		Reference guides are technical descriptions of the machinery and how to operate it.

Klinger at 20:37, 18 April 2024

2024-04-18T20:37:44Z

← Older revision		Revision as of 20:37, 18 April 2024
Line 18:		Line 18:
	* [https://nixos.org/hydra/manual/ Hydra manual]		* [https://nixos.org/hydra/manual/ Hydra manual]

			== Comparison to other resource page types ==

			* If information is more encyclopedic (with a similar scope and tone to pages on [https://www.wikipedia.org/ Wikipedia]), a page would be considered a [[:Category:Pedias\|pedia]].
			* If information is less encyclopedic and more similar to a [https://en.wikipedia.org/wiki/Compendium compendium], [https://en.wikipedia.org/wiki/Study_guide study guide], or a [https://en.wikipedia.org/wiki/Guide_to_information_sources bibliographic guide], a page would be considered a [[:Category:Guide\|guide]].
			* If information is more about direct instruction to achieve a specific task, a page would be considered a [[:Category:Tutorial\|tutorial]].
			* If a page is more just a set of tips and tricks (less instructive than a tutorial), it would be a [[:Category:Cookbook\|cookbook]].
			* If a page is a detailed reference (like a man page or full software manual), it would fit under [[:Category:reference\|references]].

	[[Category:Resource]]		[[Category:Resource]]

Klinger: extended the last paragraph with the links to the reference documentation.

2024-04-18T20:31:51Z

extended the last paragraph with the links to the reference documentation.

← Older revision		Revision as of 20:31, 18 April 2024
Line 11:		Line 11:

	Normally Reference guides have no place in the wiki as they should be part of the project documentation itself. Under very special circumstances it might be the case that Reference Documentation is stored as an wiki article for a short time e.g. upstream project currently has no place for said documentation or the first draft for a reference document will be written here before being transferred.		Normally Reference guides have no place in the wiki as they should be part of the project documentation itself. Under very special circumstances it might be the case that Reference Documentation is stored as an wiki article for a short time e.g. upstream project currently has no place for said documentation or the first draft for a reference document will be written here before being transferred.

			Content of this category should be moved to the manuals or https://nix.dev
			* [https://nixos.org/nixos/manual/ NixOS manual]
			* [https://nixos.org/nix/manual/ Nix manual]
			* [https://nixos.org/nixpkgs/manual/ Nixpkgs manual]
			* [https://nixos.org/hydra/manual/ Hydra manual]


	[[Category:Resource]]		[[Category:Resource]]

imported>Nix: make Reference a subcategory of "Resource"

2021-09-20T09:09:37Z

make Reference a subcategory of "Resource"

← Older revision		Revision as of 09:09, 20 September 2021
Line 11:		Line 11:

	Normally Reference guides have no place in the wiki as they should be part of the project documentation itself. Under very special circumstances it might be the case that Reference Documentation is stored as an wiki article for a short time e.g. upstream project currently has no place for said documentation or the first draft for a reference document will be written here before being transferred.		Normally Reference guides have no place in the wiki as they should be part of the project documentation itself. Under very special circumstances it might be the case that Reference Documentation is stored as an wiki article for a short time e.g. upstream project currently has no place for said documentation or the first draft for a reference document will be written here before being transferred.

			[[Category:Resource]]

imported>Makefu: Created page with "Reference guides are technical descriptions of the machinery and how to operate it. Reference guides have one job only: to describe. They are code-determined, because ultimat..."

2017-08-23T11:30:08Z

Created page with "Reference guides are technical descriptions of the machinery and how to operate it. Reference guides have one job only: to describe. They are code-determined, because ultimat..."

New page

Reference guides are technical descriptions of the machinery and how to operate it.

Reference guides have one job only: to describe. They are code-determined, because ultimately that's what they describe: key classes, functions, APIs, and so they should list things like functions, fields, attributes and methods, and set out how to use them.

Reference material is '''information-oriented'''.

By all means technical reference can contain examples to illustrate usage, but it should not attempt to explain basic concepts, or how to achieve achieve common tasks.

Reference material should be '''austere and to the point'''.

Normally Reference guides have no place in the wiki as they should be part of the project documentation itself. Under very special circumstances it might be the case that Reference Documentation is stored as an wiki article for a short time e.g. upstream project currently has no place for said documentation or the first draft for a reference document will be written here before being transferred.