GithubHelp home page GithubHelp logo

Comments (1)

saper avatar saper commented on July 20, 2024

I wish your comment had some hyperlinks to the concept you have mentioned, like, for example, to a Diátaxis, a pragmatic system for technical documentation writing Reddit thread.

I think Diátaxis favours being easy to the user over efficiency of documentation maintenance - being easy to the writer. In the tutorial section, for example, it promises nothing but blood, sweat and tears. I do not see much about re-use and modularity. This means, that if needed, the same information needs to be repeated in a slightly different way over and over. The core tenant of DITA seems to be trying manage this repetition.

I think nothing prevents someone to demonstrate how the toolkit provided by DITA is able to provide the documentation that is built according to the Diátaxis principles. if so desired. Personally I do not see any need to change this very repository with respect to that, though.

from diataxis-documentation-framework.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.