ASP.NET Web Pages – Quick Sheet Documentation Example (Feedback Needed)


This post provides a Quick Sheet documentation example that provides select example code, scenarios, tips and reference of an ASP.NET Web Pages helper.

 

Our team is interested in your thoughts and feedback. Here is a Quick Sheet documentation example in PDF format. It is one page that provides quick information about a helper. For this example, we used the Chart helper. The idea of the Quick Sheet is not to provide all the information about the helper, but to provide selected details about the helper. This way, developers that are new to WebMatrix and ASP.NET Web Pages with Razor Syntax can use this information to quickly move their development efforts forward.

QuickSheetExample

Please let us know what you think. Is this something you would find useful? Would you like different information? Do the existing docs provide the information you need? Would you rather see this information in another form (reference, topics, etc.)? 

Thanks!

— Erik Reitan
ASP.NET and Web Tools Developer Content Team
This posting is provided "AS IS" with no warranties, and confers no rights.


Comments (3)

  1. John Tarbox says:

    This is fantastic! I love the one page format. I also like that all the key information is in one place, for example you list both the Namespace and the assembly. I can’t begin to tell you how much time I have wasted tracking down assemblies when a sample only gave the namespace.

    Keeping it to one page makes it ideal for printing without wasting paper.

  2. Behnam Bahmani says:

    Great, I like the idea, it's like papers we prepared on high school for exam. just key things, to give general view to mind, Fantastic

  3. Tim B says:

    I like this because it helps identify key methods and properties. The ordinary documentation contains massive lists of an objects members, forcing users to spend considerable time searching for basic info. I also think the "Tips" section would be helpful.

    Frankly, I'd like to see this in place beyond Web Pages.