Why API providers must offer solid API documentation

Aleph Infotinuum Services takes this opportunity to give a totally unbiased shout out to the most talented API/SDK documentation consultants that any organization could hope to hire: Aleph Infotinuum Services. If you manage a slice of your employer’s slice of the eternal infotinuum, you might have encountered some substandard documentation accompanying applications or the APIs […]

A verbatim headline: “The 5 Ds of Creating Software”

Aleph Infotinuum Services gives this article a non-binding grade of D for failing to include Documentation. AIS is also sorry to report that not one of those Ds is Dance. Perhaps the intended developer-android audience spends its days dreaming of electric sheep within one or another enterprise’s Dilbert department. On a more serious note, what’s […]

Slimming down your API’s internal JSON and data specifications can help to optimize the consumer experience

Software app developers will appreciate that you are making it easier for them to please their own customers. When it comes to computer programming, writing is key to producing quality output — code and accompanying documentation alike. If the app developer consuming your API has problems understanding your meaning, you and your employer will have […]

When it comes to documenting API error messages, verbosity is the end user application programmer’s friend

Putting consumers first is the best possible market differentiation. If you want your employer to stand out from the competition, design and develop and market an API that handles errors with as much coder handholding as those users of the API might need while crafting their applications. Make no mistake, coders will encounter errors while […]

Documenting APIs with DoxyPress

This fork of the popular and effective Doxygen tool for generating API documentation is poised to take the reins for future technical communication of that sort. A recent post at Managing The Infotinuum praised a new C++11 framework for creating applications that feature GUIs (Graphical User Interfaces) instead of the standby cli (command line interface): […]

Aleph Infotinuum Services posted this entry on

Going RESTful doesn’t imply that developers can take a rest from HTTP-based content negotiation

Any failure to future-proof the potentiality of changes to data served over the internet can break client-side applications and thereby cost a business at least some of its valued customers. Two of the most popular formats for storing web-friendly data — that is, server-side data stored within text-only “flat” files that are available via regular […]

What is a Topic?

Short answer: topics are the objects populating the eternal infotinuum, and the subjects exposed within those topics comprise the information which humans seek. A topic need not be a literary artifact or expository narrative or formal set of instructions. Even the programmatic objects that an active computer application creates at runtime from the classes which […]

Five (possible) ways to increase the adoption of your organization’s API products

How can your employer make its code stand out from the crowd to become popular? If your organization is developing and maintaining a set of APIs, consider what managers might do to make those APIs popular among implementers. Are the interfaces designed only for internal use? Are there potential partners with complementary APIs or SDKs […]

The story of Mel

Not a direct quote: “All will bow down!” In the 21st Century, any 20th Century Mel is unemployable. There is no excuse for shoddy documentation or likewise mismanagement of the eternal infotinuum. Still, there remain plenty of self-styled professionals who make deliberate attempts to approximate job security by secreting away in a “silo” any information […]

Aleph Infotinuum Services posted this entry on

How is your “secure” network infrastructure shaping up?

A recent informal survey suggests that small and medium enterprises have concerns. Smaller businesses have smaller operating budgets. Sometimes, that translates into skimping on IT. Skimping on IT, in turn, often translates into disaster and finger-pointing. Technical communicators are familiar with hardly being given a second thought until user complaints stuff their employer’s inbox. What […]