Category:Pedias: Difference between revisions

Line 1:

Discussions are ''understanding-oriented'' articles aimed at explaining a particular topic. They are encyclopedic, intended to provide an overview of the subject at hand~~, illuminating the big picture~~ and various perspectives of it. A discussion article might be read casually for leisure, rather than being used as [[:Category:Reference|reference]] while coding.

Discussions are ''understanding-oriented'' articles aimed at explaining a particular topic. They are encyclopedic, intended to provide an overview of the subject at hand and various perspectives of it. A discussion article might be read casually for leisure, rather than being used as [[:Category:Reference|reference]] while coding.

==Style==

== Style ==

~~===Language===~~

Besides the [[Contributing to the Wiki#Style|general style considerations]], discussion articles should be written with the following considerations in mind:

~~Discussion articles should be written in clear, standard and professional language. To this end, the following considerations apply:~~

* ''Accessibility'': discussions are often the first thing a new user will read about any subject, so they should be accessible to beginners.

* ''Overview'': discussions must provide a clear overview of their subject matter, and be accordingly organized into easily navigable sections.

* ''~~Vocabulary~~'': ~~use~~ the ~~simplest and most conventional words and expressions you can find~~ to ~~get your point across without oversimplifying~~.

* ''Variety'': related to the previous point, where appropriate discussions should cover multiple workflows, approaches and perspectives to the topic.

* ''~~Organization~~'': ~~keep your text structured in coherent sentences~~, ~~paragraphs~~ and sections~~, each with its own clear themes and topics~~.

* ''~~Citations~~'': ~~citations aren't required, but definitely appreciated; when citing code, hardlink~~ to ~~a particular revision.~~

* ''Attribution'': where external material is quoted or utilized in the ~~article, and/or licensing or common sense demands it~~, ~~place clear and complete attribution and (~~where ~~possible) a link.~~

* ''Code'': code examples should ~~be cogent~~ and ~~illustrative of the surrounding text (otherwise they would normally go in one of~~ the ~~other article types)~~.

==Canonical Forms==

@@ Line 1: / Line 1: @@
-Discussions are ''understanding-oriented'' articles aimed at explaining a particular topic. They are encyclopedic, intended to provide an overview of the subject at hand, illuminating the big picture and various perspectives of it. A discussion article might be read casually for leisure, rather than being used as [[:Category:Reference|reference]] while coding.
+Discussions are ''understanding-oriented'' articles aimed at explaining a particular topic. They are encyclopedic, intended to provide an overview of the subject at hand and various perspectives of it. A discussion article might be read casually for leisure, rather than being used as [[:Category:Reference|reference]] while coding.
-==Style==
+== Style ==
-===Language===
+Besides the [[Contributing to the Wiki#Style|general style considerations]], discussion articles should be written with the following considerations in mind:
-Discussion articles should be written in clear, standard and professional language. To this end, the following considerations apply:
+* ''Accessibility'': discussions are often the first thing a new user will read about any subject, so they should be accessible to beginners.
+* ''Overview'': discussions must provide a clear overview of their subject matter, and be accordingly organized into easily navigable sections.
-* ''Vocabulary'': use the simplest and most conventional words and expressions you can find to get your point across without oversimplifying.
+* ''Variety'': related to the previous point, where appropriate discussions should cover multiple workflows, approaches and perspectives to the topic.
-* ''Organization'': keep your text structured in coherent sentences, paragraphs and sections, each with its own clear themes and topics.
-* ''Citations'': citations aren't required, but definitely appreciated; when citing code, hardlink to a particular revision.
-* ''Attribution'': where external material is quoted or utilized in the article, and/or licensing or common sense demands it, place clear and complete attribution and (where possible) a link.
-* ''Code'': code examples should be cogent and illustrative of the surrounding text (otherwise they would normally go in one of the other article types).
 ==Canonical Forms==