requisition-examples
Requisition Examples
The following are real-world examples and brainstorming for marking up requsition.
The Problem
How to consistently describe the content of a job requisition in a manner that is compatible internation standards.
Recommended sections
Top level (=):
- Introductory sentence
Second level (==):
- The Problem)
- What is the purpose of this exploration?
- Participants
- Bulleted list of who is active (or cares)
- Real-World Examples
- Links to public web pages, either popular or insightful
- Existing Practices
- Summary of common patterns discovered
- Other attempts to solve The Problem
- See Also / Next Steps
- Link to related pages as they become available
- *-formats
- *-brainstorming
- Link to related pages as they become available
Real World Examples section
- Flat list at a minimum. The real world examples section should be at a minimum a flat list of examples. See further down for what a good example has.
- Grouping into categories can help. A giant flat list of examples can sometimes be difficult to navigate and analyze as a whole. Consider grouping related examples into a flat list of categories. If you're not sure how to categorize the examples, or if there are multiple axes across which you could categorize the examples, ask on the mailing list and/or irc channel
Good Examples of Examples
The following pages are some of the best examples of instantiating this design pattern:
A Good Example Has
A good example has several things:
- URL to the actual example on the Web
- Link text of that hyperlink should be look like a citation of that example, e.g. who, what site
- Perhaps an illustrative snippet of code (markup) from the example
- Analysis of the implied schema represented by that snippet, with at a minimum a flat list of the "fields" present in the example snippet.
When Adding Examples
When adding examples to an existing *-examples page, please try to add the examples into the existing organizational structure in the page. E.g. if the examples are grouped or categorized in a certain way, try to add new examples into those existing categories, instead of a new section.
If you have to add a new category or subsection, do so, but try to do so in harmony with existing categories. If it is not obvious how to do so, or if the categories don't seem to make sense, then it might be a good time to ask a question on the mailing list or irc channel.