Recent

Author Topic: Guidance to users, simple but effective  (Read 2464 times)

hrayon

  • Full Member
  • ***
  • Posts: 118
Guidance to users, simple but effective
« on: July 28, 2023, 04:38:36 pm »
Hello
Categories in the forum, next or close to the title, could have one or more links to the wiki documentation. Or a pinned first post with a brief explanation with such links.
Many questions could be avoided if one read the wiki for that subject.
For example, the LCL category could have the link:
https://wiki.freepascal.org/LCL

Databases:
https://wiki.freepascal.org/Databases

And so on.

MarkMLl

  • Hero Member
  • *****
  • Posts: 8134
Re: Guidance to users, simple but effective
« Reply #1 on: July 28, 2023, 05:00:15 pm »
Well volunteered that man!

We've needed somebody to check that all wiki pages are up to date for ages, so we all appreciate that you're taking that on.

Until you've got that done: THE WIKI IS NOT DOCUMENTATION.

MarkMLl
MT+86 & Turbo Pascal v1 on CCP/M-86, multitasking with LAN & graphics in 128Kb.
Logitech, TopSpeed & FTL Modula-2 on bare metal (Z80, '286 protected mode).
Pet hate: people who boast about the size and sophistication of their computer.
GitHub repositories: https://github.com/MarkMLl?tab=repositories

lainz

  • Hero Member
  • *****
  • Posts: 4667
  • Web, Desktop & Android developer
    • https://lainz.github.io/
Re: Guidance to users, simple but effective
« Reply #2 on: July 28, 2023, 06:10:52 pm »
The wiki is not documentation, but where is the documentation?

dsiders

  • Hero Member
  • *****
  • Posts: 1327
Re: Guidance to users, simple but effective
« Reply #3 on: July 28, 2023, 06:31:32 pm »
The wiki is not documentation, but where is the documentation?

Look to your left...
Preview the next Lazarus documentation release at: https://dsiders.gitlab.io/lazdocsnext

hrayon

  • Full Member
  • ***
  • Posts: 118
Re: Guidance to users, simple but effective
« Reply #4 on: July 28, 2023, 09:55:43 pm »
Ok, change the term "wiki" to "official documentation", the proposal is the same.
I don't have experience with documentation, I don't know if I know enough about lazarus/fpc to indicate the best way to solve problems. Anyway, here:

https://wiki.freepascal.org/Main_Page

this is written:

"...The goal of this Wiki is to collect and store the knowledge necessary for the productive use of Free Pascal, Lazarus and related projects. The Wiki is intended to be the first port of call for users looking for information on how to use the tools provided by those projects...."

Let it be the left menu documentation then. The novice forum user with a problem wants the problem solved. Whether it was on the wiki or the official documentation doesn't matter.

Or even an experienced user like lainz.

Whoever has mastery over the category, or at least has an overview of where the category fits, is the person who created it and is probably the best person to provide the links and guidance.

Or just to justify the acronym RTFM.

lainz

  • Hero Member
  • *****
  • Posts: 4667
  • Web, Desktop & Android developer
    • https://lainz.github.io/
Re: Guidance to users, simple but effective
« Reply #5 on: July 28, 2023, 11:57:35 pm »
Unfortunatelly there is no documentation (and no time to do it) for most of bgracontrols projects, so we make demos and wikis.

So for me +1 to wiki.

 

TinyPortal © 2005-2018