One thing that would have helped me when I was first learning to program is just a tutorial on how to read documentation.   There are so many tutorials out there that explain the documentation in english but nothing that actually teaches you how to read the documentation.  The documentation is a language unto itself:

14.2.9 SELECT Syntax


SELECT
    [ALL | DISTINCT | DISTINCTROW ]
      [HIGH_PRIORITY]
      [STRAIGHT_JOIN]
      [SQL_SMALL_RESULT] [SQL_BIG_RESULT] [SQL_BUFFER_RESULT]
      [SQL_CACHE | SQL_NO_CACHE] [SQL_CALC_FOUND_ROWS]
    select_expr [, select_expr ...]
    [FROM table_references
      [PARTITION partition_list]
    [WHERE where_condition]
    [GROUP BY {col_name | expr | position}
      [ASC | DESC], ... [WITH ROLLUP]]
    [HAVING where_condition]
    [ORDER BY {col_name | expr | position}
      [ASC | DESC], ...]
    [LIMIT {[offset,] row_count | row_count OFFSET offset}]
    [PROCEDURE procedure_name(argument_list)]
    [INTO OUTFILE 'file_name'
        [CHARACTER SET charset_name]
        export_options
      | INTO DUMPFILE 'file_name'
      | INTO var_name [, var_name]]
    [FOR UPDATE | LOCK IN SHARE MODE]]
I mean what language is that?  It looks like mysql.  Is it intended to be clear?  I can kind of get an idea and it's not as bad as some things I've come across.  I don't think this would actually run if I ran it.  Maybe it would.  I just wish I'd come across tutorials on reading documentation.  Back in 1990 I got a free public domain C compiler that was advertized in a magazine.  (This was just before the internet).   I never got it to work however there were several disks loaded with documentation.  I just could barely understand the documentation.   Compiling a C program involves more than just understanding the C language.  On top of all the obscure documentation there is Assembly Language involved.   On top of that the Makefile is written in another language.  The makefile allows you to type the word make at the command line and the file will make itself.  All the books at that time only focused on the C language so you really couldn't take advantage of free software.   The expensive software would always include a way for you to go straight to programming.      However you would have to pay large amounts of money to get the hand holding you needed.     It was totally worth it of course if you could somehow get your hands on those tools and the hardware that would run it.   Just having the money wasn't enough you had to live in either New York or Los Angeles or Chicago because other cities didn't sell that stuff.

My main point though is that Documentation is a language unto itself and it's a language with no name and no Documentation of it's own.   Colleges need to teach a course in deciphering documentation and maybe YouTube could use some tutorials on it. 

Comments

Popular posts from this blog

Parable of the Growing Seed, And the Mustard Seed

Weird Trick for Making Great Art.

Fish Tank Optics.