Sticky Notes To The Rescue

I find that I am often frustrated when reading through the documentation for software of the SDK, MFC, etc. Ages ago (back in the C days) each and every function/method description would include perfectly fine examples on how to use them. Yet even that sometimes left me needing more, or with the feeling of "Yeah, but what does THIS mean, or what happens if I need to do THIS? It doesn't SAY!"

So I have a suggestion...

Post a full copy of the Microsoft documentatin and provide a facility whereby users can post "sticky notes" on them for others to read. These notes would be used to provide explanations, suggestions, little-known facts, undocumented but often-used details, examples, screen shots, tips, and just about anything else that could help the programmers to better understand the issues.

I think this would be an invaluable aid to programmers.

- Roger Garrett
[914 byte] By [RogerGarrett] at [2007-11-19 19:39:16]
# 1 Re: Sticky Notes To The Rescue
Post a full copy of the Microsoft documentatin and provide a facility whereby users can post "sticky notes" on them for others to read.
That's never going to happen, for several reasons. First, at least to my knowledge, that is illegal. Second, MSDN is huge and more important, it changes on regular basis. Third, what makes you think that all notes would actually be valuable and correct?
cilu at 2007-11-10 3:36:05 >
# 2 Re: Sticky Notes To The Rescue
That's never going to happen, for several reasons. First, at least to my knowledge, that is illegal. Second, MSDN is huge and more important, it changes on regular basis. Third, what makes you think that all notes would actually be valuable and correct?

Back when the Internet was just starting to become popular some enterprising company came up with a background application t hat you could run on your computer and it interacted with browsers (or maybe just Internet Explorer) and let you put "sticky notes" on any website you wanted to, so that when you came back to that site you'd see the notes that you posted. More interestingly, anyone else who also ran that background application on their computer would see your notes on those web pages. It was touted as a way to share thoughts on the contents of web sites.

That product never really took off, but it does point out that the technology is possible. I maintain that it would be incredibly helpful for things like software library documentation, like MFC.

Now, is it legal to post "your own" copy of the MFC documentation, without permission from MFC? Probably not. But might it be legal to set up a web page that has a "sub-page" showing the MFC pages and some kind of border around it that has additional information on it (the sticky notes area)? I think so. Consider the fact that Yahoo does something quite similar when it shows the pages that match your search criteria. What appears "around" the web page is Yahoo stuff. Perhaps something similar could be done which allows sticky notes.

Would all the postings be correct and valuable? Probably as correct and valuable as the postings on dev-archive. Some are good, many are excellent, and a few are way off base. But overall it's an excellent source of information.

I think this sticky notes idea would add one more valuable resource to software engineers.
RogerGarrett at 2007-11-10 3:37:05 >
# 3 Re: Sticky Notes To The Rescue
I think this sticky notes idea would add one more valuable resource to software engineers.
I'm not saying it wouldn't. This is the concept of collaborative documentation. Perhaps one day some company will develop such a collaborative documentation on MSDN based on a wiki engine. And perhaps it will be a hit. But frankly, I don't find your idea realistic for dev-archive.
cilu at 2007-11-10 3:38:07 >