User avatar
mahjongg
Forum Moderator
Forum Moderator
Posts: 13014
Joined: Sun Mar 11, 2012 12:19 am
Location: South Holland, The Netherlands

Re: Thinking of writing a technical FAQ

Thu Jul 12, 2018 11:14 am

I have a few FAQ:

Why does windows want to format my SD-card?

probably the most asked technical question is:
Why does my PI not boot.

and yes, all my "common pitfall" sticky posts.

User avatar
DougieLawson
Posts: 38897
Joined: Sun Jun 16, 2013 11:19 pm
Location: A small cave in deepest darkest Basingstoke, UK
Contact: Website Twitter

Re: Thinking of writing a technical FAQ

Thu Jul 12, 2018 11:56 am

How about lifting all of the sticky posts? Editting them as a well structured FAQ then removing the stickiness on the forum. That would make the forum easier to use.

The common FAQ you need to add, however you do it is: How do I start a program at boot up? Then list all of /etc/rc.local, /etc/systemd/system/myown.service, crontab -e [with a @reboot line], sudo crontab -e [which runs as root], /etc/cron.d [the official way to have system crons], /etc/cron.{daily,weekly,hourly,monthly} [run for you on a time schedule]. And for GUI Xwindows things /home/pi/.config/autostart, /home/pi/.config/lxsession/LXDE-pi/autostart [and anything else you can think of].
Note: Any requirement to use a crystal ball or mind reading will result in me ignoring your question.

Criticising any questions is banned on this forum.

Any DMs sent on Twitter will be answered next month.
All non-medical doctors are on my foes list.

User avatar
bensimmo
Posts: 4582
Joined: Sun Dec 28, 2014 3:02 pm
Location: East Yorkshire

Re: Thinking of writing a technical FAQ

Thu Jul 12, 2018 12:07 pm

DougieLawson wrote:
Thu Jul 12, 2018 11:56 am
How about lifting all of the sticky posts? Editting them as a well structured FAQ then removing the stickiness on the forum. That would make the forum easier to use.

The common FAQ you need to add, however you do it is: How do I start a program at boot up? Then list all of /etc/rc.local, /etc/systemd/system/myown.service, crontab -e [with a @reboot line], sudo crontab -e [which runs as root], /etc/cron.d [the official way to have system crons], /etc/cron.{daily,weekly,hourly,monthly} [run for you on a time schedule]. And for GUI Xwindows things /home/pi/.config/autostart, /home/pi/.config/lxsession/LXDE-pi/autostart [and anything else you can think of].
Like a short sentence and a link to this (and the link in it to cron), but expanded these sections as HowTo's also
https://www.raspberrypi.org/documentati ... c-local.md
https://www.raspberrypi.org/documentati ... ge/cron.md

jamesh
Raspberry Pi Engineer & Forum Moderator
Raspberry Pi Engineer & Forum Moderator
Posts: 26459
Joined: Sat Jul 30, 2011 7:41 pm

Re: Thinking of writing a technical FAQ

Thu Jul 12, 2018 12:52 pm

That's the way to do it, having massive sections with howto's in a FAQ just makes them unweildy. Short descriptions + links is the way to go.

I'll add these latest suggestions now.
Principal Software Engineer at Raspberry Pi (Trading) Ltd.
Contrary to popular belief, humorous signatures are allowed.
I've been saying "Mucho" to my Spanish friend a lot more lately. It means a lot to him.

User avatar
bertlea
Posts: 307
Joined: Wed Dec 07, 2016 6:33 am
Location: Hong Kong

Re: Thinking of writing a technical FAQ

Tue Jun 02, 2020 8:33 am

Looks like the FAQ is updated with the OS name to "Raspberry Pi OS", but it didn't update various places for the addition of 8G RAM model and it still contains the description: "The Raspberry Pi 4 supports up to 4GB of RAM". Also the list of models missed 8G and the text above the table missed Pi4 completely: "These are the models of the Raspberry Pi which are currently available: the Pi 3 Model B, the Pi 2 Model B, the Pi Zero, the Pi Zero W and the Pi 1 Model B+ and A+.".

jamesh
Raspberry Pi Engineer & Forum Moderator
Raspberry Pi Engineer & Forum Moderator
Posts: 26459
Joined: Sat Jul 30, 2011 7:41 pm

Re: Thinking of writing a technical FAQ

Tue Jun 02, 2020 8:38 am

We have an issue tracker for the documentation

https://github.com/raspberrypi/documentation/issues

You can easily add reports of problems there.

I'll fix up these ones anyway - no need to add an issue.
Principal Software Engineer at Raspberry Pi (Trading) Ltd.
Contrary to popular belief, humorous signatures are allowed.
I've been saying "Mucho" to my Spanish friend a lot more lately. It means a lot to him.

Return to “General discussion”