<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
		>
<channel>
	<title>Comments on: Help to improve the SDK documentation!</title>
	<atom:link href="http://blogs.exact.com/products/2010/05/help-to-improve-the-sdk-documentation/feed/" rel="self" type="application/rss+xml" />
	<link>http://blogs.exact.com/products/2010/05/help-to-improve-the-sdk-documentation/</link>
	<description></description>
	<lastBuildDate>Fri, 10 Feb 2012 16:00:52 +0000</lastBuildDate>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.3.1</generator>
	<item>
		<title>By: Gerard van de Munt</title>
		<link>http://blogs.exact.com/products/2010/05/help-to-improve-the-sdk-documentation/comment-page-1/#comment-5790</link>
		<dc:creator>Gerard van de Munt</dc:creator>
		<pubDate>Thu, 11 Nov 2010 15:28:18 +0000</pubDate>
		<guid isPermaLink="false">http://blogs.exact.com/products/?p=1617#comment-5790</guid>
		<description>Hi Gert, Thanks for this feedback. Our aim is to have those XML comments and a kind of MSDN help available end of this year. See for all the steps we are executing my next blog: http://blogs.exact.com/products/2010/10/status-update-improving-sdk-documentation/</description>
		<content:encoded><![CDATA[<p>Hi Gert, Thanks for this feedback. Our aim is to have those XML comments and a kind of MSDN help available end of this year. See for all the steps we are executing my next blog: <a href="http://blogs.exact.com/products/2010/10/status-update-improving-sdk-documentation/" rel="nofollow">http://blogs.exact.com/products/2010/10/status-update-improving-sdk-documentation/</a></p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Gert</title>
		<link>http://blogs.exact.com/products/2010/05/help-to-improve-the-sdk-documentation/comment-page-1/#comment-5688</link>
		<dc:creator>Gert</dc:creator>
		<pubDate>Mon, 08 Nov 2010 12:39:41 +0000</pubDate>
		<guid isPermaLink="false">http://blogs.exact.com/products/?p=1617#comment-5688</guid>
		<description>The main thing is Xml comments, and generate documentation. You can build Help-files that can be integrated within Visual Studio for reference, that&#039;s ideal. But also as regular help, MSDN is really a brilliant example of great helpfiles.

I wouldn&#039;t really create different pages for each version, but keep it like MSDN: same page but you can select the .Net version and get that specific help.</description>
		<content:encoded><![CDATA[<p>The main thing is Xml comments, and generate documentation. You can build Help-files that can be integrated within Visual Studio for reference, that&#8217;s ideal. But also as regular help, MSDN is really a brilliant example of great helpfiles.</p>
<p>I wouldn&#8217;t really create different pages for each version, but keep it like MSDN: same page but you can select the .Net version and get that specific help.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Frank van den Hoek</title>
		<link>http://blogs.exact.com/products/2010/05/help-to-improve-the-sdk-documentation/comment-page-1/#comment-2945</link>
		<dc:creator>Frank van den Hoek</dc:creator>
		<pubDate>Tue, 13 Jul 2010 13:29:13 +0000</pubDate>
		<guid isPermaLink="false">http://blogs.exact.com/products/?p=1617#comment-2945</guid>
		<description>Hi Gijs and Gerard,

I made a prioritized list of improvements you could consider below:

1. Documentation should be linked 1 to 1 with a batch/release. Like Microsoft does per .NET Framework release. So don&#039;t add properties to an existing document with the text behind them saying: ( from batch 395 ). No, just create a document per batch. 

2. I don&#039;t know how documentation is created now but I clearly have the idea that it is done manually. This is normal if we are talking about walk-throughs etc. For object reference documentation this is a different case. I would suggest keeping the documentation closer to the code or in between the code ( XML-doc style ) so documentation can be generated. This improves the accuracy of the documentation because you do not have to keep it in-sync manually.

3. Expand the documentation. More code examples would be nice but adding some semantics/meaning to properties and methods would be even nicer! For example: The property TransShipment of object SDKSalesOrder now has the following description: Intrastat. References field trsshpm_cd in table intshp, combined with land_iso.   This does not tell me for what purpose I should use this property!? It is technical blabla and hardly useful? 

4. Style/markup. The way the documentation is presented is not very clear. For this I refer to Microsoft&#039;s MSDN docs again. This does not mean you have to copy it exactly but I think you could learn from it.


I hope this is clear. if not, you no where to reach me.

Good luck!</description>
		<content:encoded><![CDATA[<p>Hi Gijs and Gerard,</p>
<p>I made a prioritized list of improvements you could consider below:</p>
<p>1. Documentation should be linked 1 to 1 with a batch/release. Like Microsoft does per .NET Framework release. So don&#8217;t add properties to an existing document with the text behind them saying: ( from batch 395 ). No, just create a document per batch. </p>
<p>2. I don&#8217;t know how documentation is created now but I clearly have the idea that it is done manually. This is normal if we are talking about walk-throughs etc. For object reference documentation this is a different case. I would suggest keeping the documentation closer to the code or in between the code ( XML-doc style ) so documentation can be generated. This improves the accuracy of the documentation because you do not have to keep it in-sync manually.</p>
<p>3. Expand the documentation. More code examples would be nice but adding some semantics/meaning to properties and methods would be even nicer! For example: The property TransShipment of object SDKSalesOrder now has the following description: Intrastat. References field trsshpm_cd in table intshp, combined with land_iso.   This does not tell me for what purpose I should use this property!? It is technical blabla and hardly useful? </p>
<p>4. Style/markup. The way the documentation is presented is not very clear. For this I refer to Microsoft&#8217;s MSDN docs again. This does not mean you have to copy it exactly but I think you could learn from it.</p>
<p>I hope this is clear. if not, you no where to reach me.</p>
<p>Good luck!</p>
]]></content:encoded>
	</item>
</channel>
</rss>

