How do you decide which API function documentations to read and how seriously?

Posted by Uri on Stack Overflow See other posts from Stack Overflow or by Uri
Published on 2008-10-01T22:37:11Z Indexed on 2010/04/01 1:53 UTC
Read the original article Hit count: 340

Filed under:

subjective

|

documentation

|

discussion

Suppose that you are writing or maintaining a piece of code that uses some API that you are not 100% familiar with.

How do you decide whether to read the documentation of a certain call target, and how much time to spend reading it? How do you decide not to read it?

(Let's assume you can read it by opening the HTML documentation, inspecting the source code, or using the hover mechanism in the IDE).

© Stack Overflow or respective owner

Related posts about subjective

Scoring/analysis of Subjective testing for skills assessment

as seen on Programmers - Search for 'Programmers'
I am lucky in the sense that I have been given the opportunity to be a 'Technical Troubleshooter' for our offshore development team. While I am confident and capable of dealing with most issues, I have come across something that I am not. Based on initial discussions with various team members both… >>> More
Best Practise/Subjective: Implement a finite state automaton in OOP

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi guys, I am thinking about implementing a programm with finite state automaton in an OOP language like Java or C++. What would you think is the best way to implement this with a manageable amount of available states, regarding to good software design? Is it good to implement for each state an… >>> More
Subjective question...would you use the Action delegate to avoid duplication of code?

as seen on Stack Overflow - Search for 'Stack Overflow'
Hello, I just asked a question that helps about using generics (or polymorphism) to avoid duplication of code. I am really trying to follow the DRY principle. So I just ran into the following code... Sub OutputDataToExcel() OutputLine("Output DataBlocks", 1) OutputDataBlocks() … >>> More
"Best" language /architecture for browser-based app with ODBC and sockets? (subjective)

as seen on Stack Overflow - Search for 'Stack Overflow'
Sorry to ask a subjective question, but I would welcome some advice. I am an experienced programmer of embedded s/w, but haven't done much network programming, although I have done a fair bit of hobbyist PHP. Anyway, I have to develop what is probably a fairly general type of app, as shown in this… >>> More
The best terminal emulator for a heavy terminal user?

as seen on Ask Ubuntu - Search for 'Ask Ubuntu'
I spend a lot of time at the command-line during the workday and at home too since I run Ubuntu exclusively. I've been using the default gnome terminal but I've reached a point where I'd really like to get my terminal tricked out so that my common tasks are as easy as possible. Specifically, I find… >>> More

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Statistics Used by the Query Optimizer in Microsoft SQL Server 2008 – Microsoft Whitepaper

as seen on SQL Authority - Search for 'SQL Authority'
I recently presented session on Statistics and Best Practices in Virtual Tech Days on Nov 22, 2010. The sessions was very popular and I got many questions right after the sessions. The number question I had received was where everybody can get the further information. I am very much happy that my… >>> More