Consider personalizing your employer’s API documentation for each individual programmer-consumer

Here’s a friendly tip from Aleph Infotinuum Services: be sure to include a toggle for those programmers who prefer to ignore such pretend relationships that get programmed into not only machines but also into end user behavior patterns. Transhumanism dangers aside, it is indeed a good idea for creators & maintainers of API products to […]

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 […]

Are your employer’s development teams checking in fresh code which nevertheless becomes legacy as soon as it enters the SCM repository?

There are dependable ways to reduce an organization’s legacy code, and all it requires is fewer managerial panic attacks. To be accurate, there will never be much managerial panic if those managers stick to best practice Continuous Integration/Delivery methodologies for design & architecture & implementation & delivery. One of the worst managerial mistakes is the […]

Aleph Infotinuum Services posted this entry on

There never weren’t going to be problems with Open Source software

That doesn’t mean, of course, that Open Source projects are useless — rather, it is an acknowledgement that nothing is perfect. There was a time when software was, like documentation, a complementary if proprietary add-on to a hardware purchase. Software was free of charge in that its development costs got baked in with the price […]

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 likewise 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 has problems understanding your meaning, you and your employer will have problems maintaining a […]

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 […]