Difference between revisions of "How to Read the SEBoK"
m (Text replace - "www.sebokwiki.org/" to "www.sebokwiki.org/05/") |
|||
| Line 1: | Line 1: | ||
| + | The SEBoK version 0.75 review process is intended to provide the SE community an opportunity to comment on the approach, provide feedback on current draft content, provide feedback on the wiki format, and make recommendations about future content and wiki features. The author team recommends that all reviewers read [[SEBoK 0.75 Introduction|Part 1: SEBoK 0.75 Introduction]] including the complete set of Part 1 articles, which provide the context for the rest of the materials. In addition, reviewers are encouraged to review the materials most relevant to their current roles or interests. | ||
| + | |||
| + | ==What You Will Find in the SEBoK== | ||
| + | |||
The SEBoK is a collection of several different types of articles, which are organized around central themes. There are three different articles types: | The SEBoK is a collection of several different types of articles, which are organized around central themes. There are three different articles types: | ||
| Line 5: | Line 9: | ||
*'''[[#Primary Reference Article|Primary Reference Articles]]''' - each primary reference (or reference identified as critically important) has it's own article, which provides the full bibliographic information for that source, lists the article(s) which consider the source a primary reference, and provides discussion on why the source is important for each of these articles. | *'''[[#Primary Reference Article|Primary Reference Articles]]''' - each primary reference (or reference identified as critically important) has it's own article, which provides the full bibliographic information for that source, lists the article(s) which consider the source a primary reference, and provides discussion on why the source is important for each of these articles. | ||
| − | For every article in the wiki, reviewers have an opportunity to provide feedback using the | + | For every article in the wiki, reviewers have an opportunity to provide feedback using the forum feature (DISQUS) located at the bottom of the page. Below are a series of screen shots showing the navigation features of the wiki, the different types of wiki articles and what the review features look like. (Please see [[Note to Reviewers]] for more information on reviewing SEBoK 0.75.) |
| + | |||
| + | ==Left-Hand Menu and Search Features== | ||
| + | |||
| + | For SEBoK 0.75, the author team has added expanding/collapsing menus, which reviewers may use as an additional means to navigate the SEBoK. As with SEBok 0.5, there is also an embedded search feature in the upper right hand corner of each page. | ||
| + | |||
| + | [[Placeholder for the file]] | ||
==Content Article== | ==Content Article== | ||
| Line 11: | Line 21: | ||
The following is an example of a content article, showing the different types of information contained in each article. | The following is an example of a content article, showing the different types of information contained in each article. | ||
| − | [[File: | + | [[File:HowToRead_MainContent.png|1200px]] |
| + | |||
| + | ==Review Content== | ||
| + | |||
| + | The following is a screen shot of how the discussion appears for reviewers. DISQUS (our forum widget) is embedded at the bottom of each page. Reviewers can simply type their comments in DISQUS and click on "Post As" - this will prompt a reviewer to log in. Reviewers may use existing accounts such as Google, Yahoo, Facebook, or Twitter or may create a DISQUS log in. | ||
| + | |||
| + | [[File:HowToRead_Review|1200px]] | ||
==Glossary Article== | ==Glossary Article== | ||
| Line 17: | Line 33: | ||
The following is an example of a glossary article, showing the different types of information contained in each article. | The following is an example of a glossary article, showing the different types of information contained in each article. | ||
| − | [[File: | + | [[File:HowToRead_Glossary.png|900px]] |
==Primary Reference Article== | ==Primary Reference Article== | ||
| Line 23: | Line 39: | ||
The following is an example of a primary reference article, showing the different types of information contained in each article. | The following is an example of a primary reference article, showing the different types of information contained in each article. | ||
| − | [[File: | + | [[File:HowToRead_PrimaryRef.png|900px]] |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{DISQUS}} | {{DISQUS}} | ||
Revision as of 18:06, 14 March 2012
The SEBoK version 0.75 review process is intended to provide the SE community an opportunity to comment on the approach, provide feedback on current draft content, provide feedback on the wiki format, and make recommendations about future content and wiki features. The author team recommends that all reviewers read Part 1: SEBoK 0.75 Introduction including the complete set of Part 1 articles, which provide the context for the rest of the materials. In addition, reviewers are encouraged to review the materials most relevant to their current roles or interests.
What You Will Find in the SEBoK
The SEBoK is a collection of several different types of articles, which are organized around central themes. There are three different articles types:
- Content Articles - these are the articles that comprise the main body of the SEBoK (please see Structure of the SEBoK for an explanation of the organization or SEBoK Table of Contents for the full table of contents);
- Glossary Articles - each glossary term has its own article, which is intended to provide a place for definition, definition sources, and discussion that reflects the state of practice for using this term in the community; and
- Primary Reference Articles - each primary reference (or reference identified as critically important) has it's own article, which provides the full bibliographic information for that source, lists the article(s) which consider the source a primary reference, and provides discussion on why the source is important for each of these articles.
For every article in the wiki, reviewers have an opportunity to provide feedback using the forum feature (DISQUS) located at the bottom of the page. Below are a series of screen shots showing the navigation features of the wiki, the different types of wiki articles and what the review features look like. (Please see Note to Reviewers for more information on reviewing SEBoK 0.75.)
Left-Hand Menu and Search Features
For SEBoK 0.75, the author team has added expanding/collapsing menus, which reviewers may use as an additional means to navigate the SEBoK. As with SEBok 0.5, there is also an embedded search feature in the upper right hand corner of each page.
Content Article
The following is an example of a content article, showing the different types of information contained in each article.
Review Content
The following is a screen shot of how the discussion appears for reviewers. DISQUS (our forum widget) is embedded at the bottom of each page. Reviewers can simply type their comments in DISQUS and click on "Post As" - this will prompt a reviewer to log in. Reviewers may use existing accounts such as Google, Yahoo, Facebook, or Twitter or may create a DISQUS log in.
Glossary Article
The following is an example of a glossary article, showing the different types of information contained in each article.
Primary Reference Article
The following is an example of a primary reference article, showing the different types of information contained in each article.
SEBoK Discussion
Please provide your comments and feedback on the SEBoK below. You will need to log in to DISQUS using an existing account (e.g. Yahoo, Google, Facebook, Twitter, etc.) or create a DISQUS account. Simply type your comment in the text field below and DISQUS will guide you through the login or registration steps. Feedback will be archived and used for future updates to the SEBoK. If you provided a comment that is no longer listed, that comment has been adjudicated. You can view adjudication for comments submitted prior to SEBoK v. 1.0 at SEBoK Review and Adjudication. Later comments are addressed and changes are summarized in the Letter from the Editor and Acknowledgements and Release History.
If you would like to provide edits on this article, recommend new content, or make comments on the SEBoK as a whole, please see the SEBoK Sandbox.
blog comments powered by Disqus