Beyond Comments: Build Awesome API Docs and Turn Yourself Into a Better Person

Whether you write an API for your team, organization, company or external community, it will not be complete without proper documentation. Yes, building documentation can turn into a long and tedious process, but it does not have to.

If you want to learn how to make the documentation building process fast, simple, and efficient, this presentation is for you. Come and see how to use:

• Sandcastle Help File builder

• Microsoft Assistance Markup language (MAML)

• XML code comments, and

• Microsoft Visual Studio extensions

to build first-class API documentation in various forms and formats (website, CHM file, Microsoft Word or PDF document, etc).

You will also hear the do's and don'ts of documentation writing, see how to integrate samples from your working code into documentation, and learn how to avoid duplicate work.

And don't worry, we'll talk code, too. It will be fun!

Admission: Free

Speaker: Alek Davis

http://photos2.meetupstatic.com/photos/event/5/4/4/a/600_433521578.jpeg

Alek Davis is a senior application developer at Intel Corporation who has been focusing on Microsoft technologies since 1996. His interests include enterprise software, information security, identity and access management, application deployment, and user experience (UX). Alek has a Master's Degree in Software Engineering and a Bachelor's Degree in Computer Science from California State University, Sacramento. Alek published a number of articles in academic journals and technical magazines, including MSDN Magazine, Dr. Dobb's Journal and others. Outside of the world of technology, Alek is trying to keep sanity while taking care of three preschoolers.

Agenda

6:00 PM to 6:10 PM
Registration & Networking

6:10 PM to 8:10 PM
Seminar / Workshop / QA

8:10 PM to 8:15 PM
Wrap up

Sponsors

• ConnectPoint Search Group (http://www.cpsg.com/) is paying for meetup.com

• TEKsystems (http://www.teksystems.com/) is paying for refreshments

TEKsystems is the Nation’s leading and largest Technical Staffing and IT Services provider, with almost 20 years of continuous local presence in the Sacramento area. We have extraordinarily deep relationships in place with local software companies, resulting in access to many selective job openings which are not known to the market at large. If you are interested in applying for an open Developer (any level), Architect or Technical Lead position, or if you would simply like to establish contact with a solid local Agency, please contact Josh Gurin at TEKsystems at jgurin@teksystems.com with your resume and/or call directly at 916-859-3276.

Examples of Currently Open positions:

Senior .NET Developer with specific SSIS experience

Mid-to-Senior .NET Developer with ASP.NET Web Forms and WCF experience

Mid-to-Senior .NET Developer with MVC, Entity Framework, jQuery, and HTML5 experience

Junior-to-Mid .NET Developer experience with VB.NET, C#, T-SQL, and any Third-Party Application Integration experience

• Microsoft (http://www.microsoft.com/) is providing the venue