|
| 1 | +--- |
| 2 | +layout: post |
| 3 | +title: "Vocabularies For Technical Publishing" |
| 4 | +date: 2012-06-11 |
| 5 | +--- |
| 6 | + |
| 7 | +<p><span>New |
| 8 | +Vocabularies for Technical Publishing</span><span></span><br /> |
| 9 | +<br /></p> |
| 10 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 11 | +<span><span style="font-family: Calibri;">Three |
| 12 | +new vocabularies have been proposed as the result of a collaborative effort by |
| 13 | +several Technology companies. They are specifically for use with </span><a href="http://www.w3.org/wiki/WebSchemas/TechArticleSchema"><span style="color: blue; font-family: Calibri;">Technical Articles</span></a><span style="font-family: Calibri;">, |
| 14 | +</span><a href="http://www.w3.org/wiki/WebSchemas/APIReferenceSchema"><span style="color: blue; font-family: Calibri;">API reference |
| 15 | +documentation</span></a><span style="font-family: Calibri;">, and </span><a href="http://www.w3.org/wiki/WebSchemas/CodeSchema"><span style="color: blue; font-family: Calibri;">Code</span></a><span style="font-family: Calibri;">.</span></span><span></span></div> |
| 16 | +<p><br /></p> |
| 17 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 18 | +<span style="font-family: Calibri;"><span>These |
| 19 | +proposed vocabularies will improve search engines’ understanding of |
| 20 | +documentation with technical content, and thus greatly increase the |
| 21 | +discoverability of this documentation.</span><span></span></span></div> |
| 22 | +<p><br /></p> |
| 23 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 24 | +<span style="font-family: Calibri;"><span>The |
| 25 | +following snippets highlight the potential of these new vocabularies.</span></span></div> |
| 26 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 27 | +<br /> |
| 28 | +<span><a href="http://www.w3.org/wiki/WebSchemas/TechArticleSchema"><b><span><span style="color: blue;">TechArticle</span></span></b></a></span></div> |
| 29 | +<p><br /></p> |
| 30 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 31 | +<span>Informs |
| 32 | +which product version the content is referring to</span></div> |
| 33 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 34 | +<span style="font-family: Calibri;"><b><span>This |
| 35 | +content is for version 4; and the current version is 4.5.</span></b></span></div> |
| 36 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 37 | +<span><</span><span>meta</span><span> </span><span>itemprop</span><span>=</span><span>"<span style="color: blue;">aboutProduct</span>"<span style="color: blue;"> </span><span style="color: red;">content</span><span style="color: blue;">=</span>"<span style="color: blue;">.Net Framework 4.0</span>"<span style="color: blue;"> /></span></span></div> |
| 38 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 39 | +<span><</span><span>meta</span><span> </span><span>itemprop</span><span>=</span><span>"<span style="color: blue;">currentProduct</span>"<span style="color: blue;"> </span><span style="color: red;">content</span><span style="color: blue;">=</span>"<span style="color: blue;">.Net Framework 4.5</span>"<span style="color: blue;"> /></span></span><span></span></div> |
| 40 | +<p><br /></p> |
| 41 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 42 | +<span>Informs |
| 43 | +where to get more information on the overall concept</span></div> |
| 44 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 45 | +<span style="font-family: Calibri;"><b><span>This |
| 46 | +content on “</span></b><span><a href="http://technet.microsoft.com/en-us/library/hh833682"><b><span><span style="color: blue;">Hyper-V Server 8 Beta</span></span></b></a></span><b><span>” |
| 47 | +is about the broader concept of virtualization:</span></b></span><span> </span></div> |
| 48 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 49 | +<span><</span><span>span</span><span> </span><span>itemprop</span><span>=</span><span>"<span style="color: blue;">about</span>"<span style="color: blue;"> </span><span style="color: red;">itemscope</span><span style="color: blue;"> </span><span style="color: red;">itemtype</span><span style="color: blue;">=</span>"</span><span><a href="http://schema.org/CreativeWork"><span style="font-family: Consolas; font-size: 9.5pt;"><span style="color: blue;">http://schema.org/CreativeWork</span></span></a></span><span>"<span style="color: blue;">></span></span></div> |
| 50 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 51 | +<span><</span><span>meta</span><span> </span><span>itemprop</span><span>=</span><span>"<span style="color: blue;">name</span>"<span style="color: blue;"> </span><span style="color: red;">content</span><span style="color: blue;">=</span>"<span style="color: blue;">Virtualization</span>"<span style="color: blue;">/></span></span></div> |
| 52 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 53 | +<span><</span><span>meta</span><span>itemprop</span><span>=</span><span>"<span style="color: blue;">url</span>"<span style="color: blue;"> </span><span style="color: red;">content</span><span style="color: blue;">=</span>"</span><span><a href="http://technet.microsoft.com/en-US/virtualization"><span><span style="color: blue;">http://technet.microsoft.com/en-US/virtualization</span></span></a></span><span>"<span style="color: blue;">/></span></span></div> |
| 54 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 55 | +<span></</span><span>span</span><span>></span><span></span></div> |
| 56 | +<p><br /></p> |
| 57 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 58 | +<span>Maps content |
| 59 | +to the audience’s intent</span><span></span></div> |
| 60 | +<p><br /></p> |
| 61 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 62 | +<span style="font-family: Calibri;"><b><span>This |
| 63 | +is content that describes how to do something:</span></b></span></div> |
| 64 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 65 | +<span>itemprop</span><span>=</span><span>"<span style="color: blue;">genre</span>"<span style="color: blue;"> </span><span style="color: red;">content</span><span style="color: blue;">=</span>"<span style="color: blue;">How-to</span>"</span></div> |
| 66 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 67 | +<span style="font-family: Calibri;"><b><span>This |
| 68 | +content describes steps for troubleshooting:</span></b></span></div> |
| 69 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 70 | +<span>itemprop</span><span>=</span><span>"<span style="color: blue;">genre</span>"<span style="color: blue;"> </span><span style="color: red;">content</span><span style="color: blue;">=</span>"<span style="color: blue;">Troubleshooting</span>"</span><span></span></div> |
| 71 | +<p><br /></p> |
| 72 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 73 | +<b><u><span><a href="http://www.w3.org/wiki/WebSchemas/APIReferenceSchema"><span><span style="color: blue;">APIReference</span></span></a></span></u></b><span></span></div> |
| 74 | +<p><br /></p> |
| 75 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 76 | +<span>Disambiguates |
| 77 | +version and usage</span> |
| 78 | + |
| 79 | +<br /> |
| 80 | +<br /> |
| 81 | +<div style="background: white; margin-left: 0.5in;"> |
| 82 | +<b><span style="color: #404040;">This content refers to a managed assembly:<br /> |
| 83 | +</span></b><span style="color: red; font-family: Consolas; font-size: 9.5pt;">itemprop</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">="</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">programmingModel</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">" </span><span style="color: red; font-family: Consolas; font-size: 9.5pt;">content</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">="</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">Managed</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">" <br /> |
| 84 | +</span><span style="color: red; font-family: Consolas; font-size: 9.5pt;">itemprop</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">="</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">assembly</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">" </span><span style="color: red; font-family: Consolas; font-size: 9.5pt;">content</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">="</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">mscorlib.dll</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">" /> </span></div> |
| 85 | +<br /> |
| 86 | +<span style="color: #4f81bd;">Defines platform |
| 87 | +category </span><br /> |
| 88 | +<br /> |
| 89 | +<div style="background: white; margin-left: 0.5in;"> |
| 90 | +<b><span style="color: #404040;">This reference documentation applies to the phone platform:</span></b></div> |
| 91 | +<div style="background: white; margin-left: 0.5in;"> |
| 92 | +<span style="color: red; font-family: Consolas; font-size: 9.5pt;">itemprop</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">=</span><span style="font-family: Consolas; font-size: 9.5pt;">"<span style="color: blue;">aboutProduct</span>"<span style="color: blue;"> </span><span style="color: red;">content</span><span style="color: blue;">=</span>"<span style="color: blue;"><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">.Net |
| 93 | +Framework 4.5</span>"</span></span></div> |
| 94 | +<div style="background: white; margin-left: 0.5in;"> |
| 95 | +<span style="color: red; font-family: Consolas; font-size: 9.5pt;">itemprop</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">=</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">"</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">targetPlatform</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">"</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;"> </span><span style="color: red; font-family: Consolas; font-size: 9.5pt;">content</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">=</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">"</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">phone</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">"</span></div> |
| 96 | +<div style="margin-left: 0.5in;"> |
| 97 | +<br /></div> |
| 98 | +<div style="background: white; margin-left: 0.5in;"> |
| 99 | +<b><span style="color: #404040;">This reference documentation applies to the desktop platform:</span></b></div> |
| 100 | +<div style="background: white; margin-left: 0.5in;"> |
| 101 | +<span style="color: red; font-family: Consolas; font-size: 9.5pt;">itemprop</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">=</span><span style="font-family: Consolas; font-size: 9.5pt;">"<span style="color: blue;">aboutProduct</span>"<span style="color: blue;"> </span><span style="color: red;">content</span><span style="color: blue;">=</span>"<span style="color: blue;"><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">.Net |
| 102 | +Framework 4.5</span></span>"</span></div> |
| 103 | +<div style="background: white; margin-left: 0.5in;"> |
| 104 | +<span style="color: red; font-family: Consolas; font-size: 9.5pt;">itemprop</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">=</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">"</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">targetPlatform</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">"</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;"> </span><span style="color: red; font-family: Consolas; font-size: 9.5pt;">content</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">=</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">"</span><span style="color: blue; font-family: Consolas; font-size: 9.5pt;">desktop</span><span style="color: #404040; font-family: Consolas; font-size: 9.5pt;">"</span></div> |
| 105 | +</div> |
| 106 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 107 | +<br /> |
| 108 | +<br /> |
| 109 | +<span><a href="http://www.w3.org/wiki/WebSchemas/CodeSchema"><b><span><span style="color: blue;">Code</span></span></b></a></span></div> |
| 110 | +<p><br /></p> |
| 111 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 112 | +<span>Defines |
| 113 | +section of content as sample code</span><span></span></div> |
| 114 | +<p><br /></p> |
| 115 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 116 | +<span style="font-family: Calibri;"><b><span>This |
| 117 | +Code is a C++ sample inserted in an article:</span></b></span></div> |
| 118 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 119 | +<span><</span><span>div </span><span>itemscope itemtype</span><span>="</span><span><a href="http://schema.org/Code"><span style="font-family: Consolas; font-size: 9.5pt;"><span style="color: blue;">http://schema.org/Code</span></span></a></span><span>"> </span></div> |
| 120 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 1in;"> |
| 121 | +<span><</span><span>meta</span><span> </span><span>itemprop</span><span>="name" </span><span>content</span><span>=" Allocating Memory from a NUMA Node "/></span></div> |
| 122 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 1in;"> |
| 123 | +<span><</span><span>meta</span><span> </span><span>itemprop</span><span>="sampleType" </span><span>content</span><span>=" inline"/></span></div> |
| 124 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 1in;"> |
| 125 | +<span><</span><span>div</span><span> </span><span>itemprop</span><span>="programmingLanguage"> </span></div> |
| 126 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 1.5in;"> |
| 127 | +<span>C++</span></div> |
| 128 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 1in;"> |
| 129 | +<span></</span><span>div</span><span>> </span></div> |
| 130 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 131 | +<span></</span><span>div</span><span>> </span></div> |
| 132 | +<p><br /></p> |
| 133 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 134 | +<span style="font-family: Calibri;"><b><span>This |
| 135 | +is a full visual studio solution in an MSDN Code Gallery:</span></b></span></div> |
| 136 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 137 | +<span><</span><span>div</span><span> </span><span>itemscope itemtype</span><span>="</span><span><a href="http://schema.org/Code"><span style="font-family: Consolas; font-size: 9.5pt;"><span style="color: blue;">http://schema.org/Code</span></span></a></span><span>"> </span></div> |
| 138 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 1in;"> |
| 139 | +<span lang="ES-US"><</span><span lang="ES-US">meta</span><span lang="ES-US"> </span><span lang="ES-US">itemprop</span><span lang="ES-US">="codeRepository" </span><span lang="ES-US">content</span><span lang="ES-US">="<u><a href="http://code.msdn.microsoft.com/Web-"><span style="color: blue;">http://code.msdn.microsoft.com/Web-</span></a></u>Authentication-d0485122/view/SourceCode" |
| 140 | +/> </span></div> |
| 141 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 1in;"> |
| 142 | +<span><</span><span>meta</span><span> </span><span>itemprop</span><span>="sampleType" </span><span>content</span><span>="Visual Studio solution(SLN)" /> </span></div> |
| 143 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt 0.5in;"> |
| 144 | +<span></</span><span>div</span><span>> </span><span></span></div> |
| 145 | +<p><br /></p> |
| 146 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 147 | +<span style="font-family: Calibri;"><span>We would like this community’s feedback concerning the above |
| 148 | +proposals.</span></span><span> </span></div> |
| 149 | +<p><br /></p> |
| 150 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 0pt;"> |
| 151 | +<span style="font-family: Calibri;"><span>Thanks!</span><span></span></span></div> |
| 152 | +<p><br /></p> |
| 153 | +<div class="MsoNormal" style="line-height: normal; margin: 0in 0in 6pt;"> |
| 154 | +<span style="font-family: Calibri;"><span>Charlie Jiang and Kenley Lamaute</span></span></div> |
0 commit comments