P:Documentation/Naming Conventions - Revision history

Alexau: /* Intro */

2018-10-30T00:06:10Z

Intro

← Older revision		Revision as of 00:06, 30 October 2018
Line 7:		Line 7:
	The documentation system is as follows:		The documentation system is as follows:
	----		----
	There are 7 general ~~categories~~ that everything fits into:		There are 7 general "Categories" that everything fits into:
	* Community - the people who make Open Source Ecology AND any work that develops this community		* Community - the people who make Open Source Ecology AND any work that develops this community
	* Management - the process for how you do things		* Management - the process for how you do things
Line 16:		Line 16:
	* Praxis - the philosophy and practice of OSE ideals		* Praxis - the philosophy and practice of OSE ideals
	----		----
	~~While everything falls into these categories, we only~~ specify ~~these major pages~~ for each ~~of these categories~~:		We specify "Major Pages" for each Category:
	* ~~community~~		* Community (supporters, entrepreneurs, researchers, onboarding)
	** supporters		* Management (disciplined entrepreneurship, holacracy, meetings, metrics)
	** entrepreneurs		* Finance (budget)
	** researchers		* product (anything in the Global Village Construction Set)
	** onboarding		* Traction (physical advertising, direct sales)
	* ~~management~~		* Marketing (any materials or guidelines that support traction)
	** disciplined entrepreneurship		* Praxis (OSE Spec)
	** holacracy		----
	** meetings		When we name create new "Topics," name the Topic based on how it relates to a Major Page:
	** metrics		* P: this is a process. Is it something that people do? This includes surveys, onboarding, and presentations.
	* ~~finance~~		* O: this is an object. Is it a thing or something that a process uses or produces?
	** budget		* Nmap: this is a narrative that maps interactions between processes AND objects. Is it a complex idea or a statement on "what could be?" (like the GVCS)
	* product		* Nfolk: this is a narrative for people and orgs. Is this about some person or org?
	** ~~3D Printer~~		* Nview: this is a narrative that captures reflections on things that exist. Is it an opinion or recommendation?
	* ~~marketing~~		----
	** ~~positioning~~		To create the full topic name, use these grammatical conventions:
	* ~~traction~~		* [Category Type Abbreviation]:[Major Page]/[Topic Page]::[Status or State of the Topic] X [Like a Date] X [Place] X [Or Particular Perspective]
	** ~~physical advertising~~		----
	** direct sales		Here's some examples:
	* praxis		*
	** OSE Spec

Alexau: /* Intro */

2018-10-29T23:50:46Z

Intro

← Older revision		Revision as of 23:50, 29 October 2018
Line 4:		Line 4:
	* '''Contributors''' - know how to add new topics to existing ones		* '''Contributors''' - know how to add new topics to existing ones
	* '''Upkeep''' - manage complexity by prioritizing upkeep of some parts of the wiki over others and manage team energy		* '''Upkeep''' - manage complexity by prioritizing upkeep of some parts of the wiki over others and manage team energy

			The documentation system is as follows:
	----		----
	~~The documentation system is as follows:~~
	There are 7 general categories that everything fits into:		There are 7 general categories that everything fits into:
	** Community - the people who make Open Source Ecology AND any work that develops this community		* Community - the people who make Open Source Ecology AND any work that develops this community
	** Management - the process for how you do things		* Management - the process for how you do things
	** Marketing - how to explain what we do (strategy, positioning)		* Marketing - how to explain what we do (strategy, positioning)
	** Traction - how we reach people and get them to buy/do (execution)		* Traction - how we reach people and get them to buy/do (execution)
	** Product - things we build		* Product - things we build
	** Finance - how we have enough money to keep going		* Finance - how we have enough money to keep going
	** Praxis - the philosophy and practice of OSE ideals		* Praxis - the philosophy and practice of OSE ideals
			----
			While everything falls into these categories, we only specify these major pages for each of these categories:
			* community
			** supporters
			** entrepreneurs
			** researchers
			** onboarding
			* management
			** disciplined entrepreneurship
			** holacracy
			** meetings
			** metrics
			* finance
			** budget
			* product
			** 3D Printer
			* marketing
			** positioning
			* traction
			** physical advertising
			** direct sales
			* praxis
			** OSE Spec

Alexau: /* Intro */

2018-10-29T23:41:17Z

Intro

← Older revision		Revision as of 23:41, 29 October 2018
Line 1:		Line 1:
	== Intro ==		== Intro ==
	~~Clarify how topics~~ in the wiki ~~relate to each other, especially for~~:		Name things in the wiki so people can find it. For example:
	* '''Newcomers''' - see how things relate to each other		* '''Newcomers''' - see how things relate to each other
	* '''Contributors''' - know how to add new topics to existing ones		* '''Contributors''' - know how to add new topics to existing ones
	* '''Upkeep''' - manage complexity by prioritizing upkeep of some parts of the wiki over others and manage team energy		* '''Upkeep''' - manage complexity by prioritizing upkeep of some parts of the wiki over others and manage team energy
			----
			The documentation system is as follows:
			There are 7 general categories that everything fits into:
			** Community - the people who make Open Source Ecology AND any work that develops this community
			** Management - the process for how you do things
			** Marketing - how to explain what we do (strategy, positioning)
			** Traction - how we reach people and get them to buy/do (execution)
			** Product - things we build
			** Finance - how we have enough money to keep going
			** Praxis - the philosophy and practice of OSE ideals




	The idea is to use naming conventions based on BEMIT, a CSS naming convention.		The idea is to use naming conventions based on BEMIT, a CSS naming convention.

Alexau: /* Intro */

2018-10-19T04:59:10Z

Intro

← Older revision		Revision as of 04:59, 19 October 2018
Line 25:		Line 25:
	* Add modifiers using '''double-colons,''' such as "O:3D Printer/Frame::PVC Pipe"		* Add modifiers using '''double-colons,''' such as "O:3D Printer/Frame::PVC Pipe"
	* For objects with multiple modifiers, use the topic X topic convention, such as "O:3D Printer/Frame::PVC Pipe X 18.10" and "O:3D Printer/Frame::PVC Pipe X 18.11"		* For objects with multiple modifiers, use the topic X topic convention, such as "O:3D Printer/Frame::PVC Pipe X 18.10" and "O:3D Printer/Frame::PVC Pipe X 18.11"
	* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O:3D Printer/Frame:PVC Pipe X Off-the-shelf" and "O:3D Printer/Frame::PVC Pipe X 3D Printed" In this case. it's still a type of frame and it's better to nest as little as possible.		* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O:3D Printer/Frame::PVC Pipe X Off-the-shelf" and "O:3D Printer/Frame::PVC Pipe X 3D Printed" In this case. it's still a type of frame and it's better to nest as little as possible.

	Additionally, I recommend these '''content conventions:'''		Additionally, I recommend these '''content conventions:'''

Alexau: /* Intro */

2018-10-19T04:58:17Z

Intro

← Older revision		Revision as of 04:58, 19 October 2018
Line 25:		Line 25:
	* Add modifiers using '''double-colons,''' such as "O:3D Printer/Frame::PVC Pipe"		* Add modifiers using '''double-colons,''' such as "O:3D Printer/Frame::PVC Pipe"
	* For objects with multiple modifiers, use the topic X topic convention, such as "O:3D Printer/Frame::PVC Pipe X 18.10" and "O:3D Printer/Frame::PVC Pipe X 18.11"		* For objects with multiple modifiers, use the topic X topic convention, such as "O:3D Printer/Frame::PVC Pipe X 18.10" and "O:3D Printer/Frame::PVC Pipe X 18.11"
	* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O:3D Printer/Frame:PVC Pipe X Off-the-shelf" and "O:3D Printer/Frame::PVC Pipe X 3D-Printed" In this case. it's still a type of frame and it's better to nest as little as possible.		* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O:3D Printer/Frame:PVC Pipe X Off-the-shelf" and "O:3D Printer/Frame::PVC Pipe X 3D Printed" In this case. it's still a type of frame and it's better to nest as little as possible.

	Additionally, I recommend these '''content conventions:'''		Additionally, I recommend these '''content conventions:'''

Alexau: /* Intro */

2018-10-19T04:56:52Z

Intro

← Older revision		Revision as of 04:56, 19 October 2018
Line 23:		Line 23:
	* Always nest views as a child of a topic, such as "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry"		* Always nest views as a child of a topic, such as "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry"
	* Only ever include 1 topic type, which always refers to the most nested child topic, so compare these two: "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry" and "Nmap:Disciplined Entrepreneurship X Priorities X Critical Path X Traction"		* Only ever include 1 topic type, which always refers to the most nested child topic, so compare these two: "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry" and "Nmap:Disciplined Entrepreneurship X Priorities X Critical Path X Traction"
	* Add modifiers using '''double-colons,''' such as "O: 3D Printer/Frame::PVC Pipe"		* Add modifiers using '''double-colons,''' such as "O:3D Printer/Frame::PVC Pipe"
	* For objects with multiple modifiers, use the topic X topic convention, such as "O:3D Printer/Frame::PVC Pipe X 18.10" and "O:3D Printer/Frame::PVC Pipe X 18.11"		* For objects with multiple modifiers, use the topic X topic convention, such as "O:3D Printer/Frame::PVC Pipe X 18.10" and "O:3D Printer/Frame::PVC Pipe X 18.11"
	* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O:3D Printer/Frame:PVC Pipe X Off-the-shelf" and "O:3D Printer/Frame::PVC Pipe X 3D-Printed" In this case. it's still a type of frame and it's better to nest as little as possible.		* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O:3D Printer/Frame:PVC Pipe X Off-the-shelf" and "O:3D Printer/Frame::PVC Pipe X 3D-Printed" In this case. it's still a type of frame and it's better to nest as little as possible.

Alexau: /* Intro */

2018-10-19T04:56:20Z

Intro

← Older revision		Revision as of 04:56, 19 October 2018
Line 23:		Line 23:
	* Always nest views as a child of a topic, such as "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry"		* Always nest views as a child of a topic, such as "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry"
	* Only ever include 1 topic type, which always refers to the most nested child topic, so compare these two: "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry" and "Nmap:Disciplined Entrepreneurship X Priorities X Critical Path X Traction"		* Only ever include 1 topic type, which always refers to the most nested child topic, so compare these two: "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry" and "Nmap:Disciplined Entrepreneurship X Priorities X Critical Path X Traction"
	* Add modifiers using colons, such as "O: 3D Printer/Frame:PVC Pipe"		* Add modifiers using '''double-colons,''' such as "O: 3D Printer/Frame::PVC Pipe"
	* For objects with multiple modifiers, use the topic X topic convention, such as "O:3D Printer/Frame: PVC Pipe X 18.10" and "O: 3D Printer/Frame:PVC Pipe X 18.11"		* For objects with multiple modifiers, use the topic X topic convention, such as "O:3D Printer/Frame::PVC Pipe X 18.10" and "O:3D Printer/Frame::PVC Pipe X 18.11"
	* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O: 3D Printer/Frame: PVC Pipe X Off-the-shelf" and "O: 3D Printer/Frame: PVC Pipe X 3D-Printed" In this case. it's still a type of frame and it's better to nest as little as possible.		* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O:3D Printer/Frame:PVC Pipe X Off-the-shelf" and "O:3D Printer/Frame::PVC Pipe X 3D-Printed" In this case. it's still a type of frame and it's better to nest as little as possible.

	Additionally, I recommend these '''content conventions:'''		Additionally, I recommend these '''content conventions:'''

Alexau: /* Intro */

2018-10-19T04:54:01Z

Intro

← Older revision		Revision as of 04:54, 19 October 2018
Line 17:		Line 17:
	* abbreviate these types so that the first word is just a letter: P, O, Nfolk, Nmap, Nview		* abbreviate these types so that the first word is just a letter: P, O, Nfolk, Nmap, Nview
	* 3 types of relationships within naming conventions: parent&child, topicXtopic, and topic=>modifier		* 3 types of relationships within naming conventions: parent&child, topicXtopic, and topic=>modifier
	* Titlecase topics, such as: "Documentation Standards" or "Global Village Construction Set"		* Titlecase topics, such as: "P:Documentation Standards" or "Nmap:Global Village Construction Set"
	* Pre-pend topics with the topic type, such as "P:Documentation Standards" or "Nmap:Global Village Construction Set" (follows existing File:xyz.pdf convention)		* Pre-pend topics with the topic type, such as "P:Documentation Standards" or "Nmap:Global Village Construction Set" (follows existing File:xyz.pdf convention)
	* Nest child topics using the url / convention, such as "O:3D Printer/Frame"		* Nest child topics using the url / convention, such as "O:3D Printer/Frame"
	* String neighboring topics using the X convention, such as "Nmap: Disciplined Entrepreneurship X Priorities X Critical Path X Traction"		* String neighboring topics using the X convention, such as "Nmap:Disciplined Entrepreneurship X Priorities X Critical Path X Traction"
	* Always nest views as a child of a topic, such as "Nview: Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry"		* Always nest views as a child of a topic, such as "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry"
	* Only ever include 1 topic type, which always refers to the most nested child topic, so compare these two: "Nview: Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry" and "Nmap: Disciplined Entrepreneurship X Priorities X Critical Path X Traction"		* Only ever include 1 topic type, which always refers to the most nested child topic, so compare these two: "Nview:Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry" and "Nmap:Disciplined Entrepreneurship X Priorities X Critical Path X Traction"
	* Add modifiers using colons, such as "O: 3D Printer/Frame: PVC Pipe"		* Add modifiers using colons, such as "O: 3D Printer/Frame:PVC Pipe"
	* For objects with multiple modifiers, use the topic X topic convention, such as "O: 3D Printer/Frame: PVC Pipe X 18.10" and "O: 3D Printer/Frame: PVC Pipe X 18.11"		* For objects with multiple modifiers, use the topic X topic convention, such as "O:3D Printer/Frame: PVC Pipe X 18.10" and "O: 3D Printer/Frame:PVC Pipe X 18.11"
	* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O: 3D Printer/Frame: PVC Pipe X Off-the-shelf" and "O: 3D Printer/Frame: PVC Pipe X 3D-Printed" In this case. it's still a type of frame and it's better to nest as little as possible.		* When given the option between making something a modifier or a child, lean towards making it a modifier, such as "O: 3D Printer/Frame: PVC Pipe X Off-the-shelf" and "O: 3D Printer/Frame: PVC Pipe X 3D-Printed" In this case. it's still a type of frame and it's better to nest as little as possible.

Alexau: Alexau moved page P: Documentation/Naming Conventions to P:Documentation/Naming Conventions: test if documentation is still findable w/o spacing

2018-10-19T04:45:38Z

Alexau moved page P: Documentation/Naming Conventions to P:Documentation/Naming Conventions: test if documentation is still findable w/o spacing

← Older revision

Revision as of 04:45, 19 October 2018

Alexau at 04:45, 19 October 2018

2018-10-19T04:45:05Z

← Older revision		Revision as of 04:45, 19 October 2018
Line 18:		Line 18:
	* 3 types of relationships within naming conventions: parent&child, topicXtopic, and topic=>modifier		* 3 types of relationships within naming conventions: parent&child, topicXtopic, and topic=>modifier
	* Titlecase topics, such as: "Documentation Standards" or "Global Village Construction Set"		* Titlecase topics, such as: "Documentation Standards" or "Global Village Construction Set"
	* Pre-pend topics with the topic type, such as "P: Documentation Standards" or "Nmap: Global Village Construction Set"		* Pre-pend topics with the topic type, such as "P:Documentation Standards" or "Nmap:Global Village Construction Set" (follows existing File:xyz.pdf convention)
	* Nest child topics using the url / convention, such as "3D Printer/Frame"		* Nest child topics using the url / convention, such as "O:3D Printer/Frame"
	* String neighboring topics using the X convention, such as "Nmap: Disciplined Entrepreneurship X Priorities X Critical Path X Traction"		* String neighboring topics using the X convention, such as "Nmap: Disciplined Entrepreneurship X Priorities X Critical Path X Traction"
	* Always nest views as a child of a topic, such as "Nview: Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry"		* Always nest views as a child of a topic, such as "Nview: Disciplined Entrepreneurship X Priorities X Critical Path X Traction/Pro-inquiry"