Re: [RFC] [Discussion] Using and Mentioning Third-party Packages in PHP Documentation and Web Projects
| From: | Nick Lockheart | Date: | Wed, 28 Aug 2024 14:28:23 +0000 |
| Subject: | Re: [RFC] [Discussion] Using and Mentioning Third-party Packages in PHP Documentation and Web Projects | ||
| References: | 1 2 3 | Groups: | php.internals |
| Request: | Send a blank email to internals+get-125338@lists.php.net to get a copy of this message | ||
>
> What a couple of people have touched on is that that all we have
> right now is a Reference, which is only one kind of documentation.
> The common zeitgeist these days says there's 4:
> https://diataxis.fr/
>
> * Tutorials
> * How-to guides
> * Explanation
> * Reference
>
> We have a reference with gaps, and that's about it. In practice, it
> will be functionally impossible to write a meaningful tutorial or
> how-to guide that never mentions anything but php-src-provided code.
> Or at least the result would be sub-standard and doing the reader a
> disservice.
>
> I don't think I'd support a list of "popular" frameworks, but
> mentioning Composer, Xdebug, and PHPUnit seems a requirement for a
> useful modern tutorial.
>
> Admittedly, the docs team is very under-resourced right now and even
> the reference section has not-small holes, making maintaining even
> more types of documentation a potential challenge. That's something
> the Foundation could possibly help with. But that's not the topic at
> hand: The topic at hand is just "look, we should be able to mention
> Composer, Xdebug, and PHPUnit, OK?" On which I very much am in
> agreement.
>
Since we are talking about 3rd party tools, is "documentation" not a
tool?
Could we have a section for "further learning" that links to books and
websites?