PlanetSquires Forums

Please login or register.

Login with username, password and session length
Advanced search  

Author Topic: Thought for today...  (Read 1125 times)

Paul Squires

  • Administrator
  • Master Member
  • *****
  • Posts: 8483
  • Windows 10
    • PlanetSquires Software
Thought for today...
« on: May 09, 2017, 07:55:06 PM »

I hate writing documentation.....


Putting together some help file info for the new WinLib library I am writing and I find it so tedious. Wish I could make it more exciting. lol
Paul Squires
PlanetSquires Software
FireFly Visual Designer, WinFBE Editor

Eddy Van Esch

  • FireFly3 Registered User
  • Senior Member
  • *
  • Posts: 242
  • FF3 User
    • DevOTechS
Re: Thought for today...
« Reply #1 on: May 10, 2017, 04:35:35 AM »

I agree. I have the same feeling when I have to write manuals and documentation for my dayjob (mechanical engineering).

For software docs, probably the 'easiest' way is to add info to the documentation as you make progress with your software. If you add new functionality to the software, immediately add it in the documentation too. That way, the info is still fresh in your head. Doesn't have to be complete immediately though ....

Knuth Konrad

  • FireFly3 Registered User
  • Junior Member
  • *
  • Posts: 64
Re: Thought for today...
« Reply #2 on: May 12, 2017, 06:49:28 AM »

There are some tools out there that help ease the pain a bit, mostly when it comes to document source code/libraries, i.e. Doxygen. Although initially aimed at C++, it can be customized for other languages.

As always when dealing with "niche BASICs", hunting down VB Classic or VB.NET examples.

Disclaimer: I haven't actually used it, but have seen a couple of help files created by it.