Share
Donc, vous avez maintenant un cadre de thème WordPress. Toutes nos félicitations! Les efforts que vous avez déployés pour le développer porteront leurs fruits à long terme et rendront votre processus de développement plus simple, plus rationnel et plus efficace..
Mais vous devez faire une dernière chose avant d’avoir terminé, à savoir documenter votre cadre. Au minimum, vous devrez vous assurer que de bons commentaires sont utilisés dans votre code, mais il est également utile d'écrire une autre documentation afin de pouvoir garder une trace des fichiers, des fonctions et des filtres qui constituent l'API de votre infrastructure..
Les options que je couvrirai sont:
Notez que bien que je mentionnerai quelques outils de documentation, ce tutoriel ne sert pas de recommandation car je ne les ai pas utilisés pour mon propre framework. Vous devrez donc vous faire votre propre jugement quant à leur pertinence..
Les commentaires sont particulièrement importants lorsque d'autres développeurs travaillent avec votre code (par exemple, si vous faites partie d'une équipe ou si vous allez publier votre infrastructure). Mais ils sont également inestimables si vous travaillez seuls, car il est très facile d’oublier exactement ce que fait un morceau de code quand vous venez de le modifier un an ou plus dans la suite..
Imaginez que vous utilisiez votre framework pour créer un site client. Dans deux ans, le site pose un problème à 5h30 le vendredi après-midi. De bons commentaires peuvent faire la différence entre résoudre les problèmes rapidement et rester à la maison le week-end, éviter de parcourir des centaines de lignes de code et manquer votre vendredi soir..
Voici quelques conseils pour de bons commentaires:
Accentsconagua
@paquet) et quelle version du thème il a été mis en place depuis (@puisque). Vous devriez utiliser un système similaire pour les fichiers de plugin./ ** * Nom du modèle: sidebar-products.php * * Le fichier d'inclusion utilisé pour la barre latérale sur les pages utilisant le modèle single-product.php. Affiche une galerie d'images de produits (en omettant l'image sélectionnée qui est affichée dans le contenu). * * @package wpptl-theme-framework * @since version 1.0 * /
UNE readme.txt fichier est le prochain niveau après avoir commenté. C’est un fichier unique que vous incluez dans votre thème, contenant des informations sur le thème..
Le paquet de code qui accompagne cette série comprend un simple readme.txt fichier:
Créer votre propre cadre de thème WordPress Ce thème prend en charge la 6ème partie de cette série pour wptutsplus. Le thème comprend les fichiers de modèle suivants: archive.php index.php page.php - pour les pages statiques page-full-width.php archive.php - pour les pages d'archive header.php sidebar.php footer.php loop.php loop-single .php loop-page.php functions.php Le thème prend en charge les images, les menus et les widgets en vedette, et les utilise comme suit: Images en vedette: elles sont affichées dans les modèles d'archive et d'index s'ils sont présents, en utilisant la taille moyenne. Menus: le menu par défaut est dans header.php et utilise l’administration des menus Styling Le thème utilise un CSS orienté objet (OOCSS). Les classes suivantes sont pour la mise en page et vous pouvez les utiliser dans vos pages et vos publications. Ils sont réactifs, ils seront donc redimensionnés sur des écrans plus petits (par exemple, la classe .half est pleine largeur sur les téléphones) .full-width, trois-quarts, deux tiers, demi, troisième, quart. Crochets Il y a 7 crochets d'action: Au-dessus de la header À l'intérieur de l'en-tête Avant le contenu Après le contenu Dans la barre latérale Dans le pied de page Après le pied de page Il y a 3 crochets de filtre: 1 dans l'en-tête 2 du pied de page Zones du widget Il y a six zones de widgets, toutes ajoutées via le fichier widgets.php: - un dans l'en-tête - un dans la barre latérale - quatre dans le pied de page
Si vous voulez faire votre readme déposer plus convivial, vous pouvez envisager de créer un readme.html fichier à la place qui s’ouvrira dans le navigateur de l’utilisateur. Vous pouvez utiliser CSS pour marquer votre readme fichier et le rendre plus facile à lire.
Si vous souhaitez diffuser votre thème au public via le référentiel de thèmes WordPress, vous devrez fournir une readme.txt fichier en tant que forme minimale de documentation. Je traiterai de cela plus en détail dans le dernier tutoriel de cette série sur la publication de votre cadre de thème..
Si vous envisagez de continuer à développer votre infrastructure et que vous ne voulez pas passer beaucoup de temps à écrire manuellement la documentation de chaque nouvelle fonctionnalité, un outil de documentation automatisé peut être la solution..
La plupart d'entre elles impliquent l'utilisation de balises ou de syntaxes spécifiques pour permettre au système d'identifier où générer la documentation. Les exemples comprennent:
Si vous envisagez d’utiliser l’un de ces outils, il vaut la peine de passer du temps à identifier celui qui vous convient le mieux avant de commencer, car vous ne pourrez pas transférer votre documentation de l’un à l’autre..
Mais une fois que vous avez maîtrisé le système et que vous l’avez configuré, un outil automatisé comme celui-ci peut vous faire gagner beaucoup de temps et éviter des lacunes dans votre documentation tout au long de la ligne, car vous serez tellement occupé à écrire du code. n'avez pas le temps de mettre à jour vos documents.
Cette option nécessitera plus de travail et ne vaut la peine d’être faite que si vous voyez votre infrastructure grandir avec le temps et gagner un nombre important d’utilisateurs. Tous les principaux cadres thématiques ont leur propre site Web avec documentation, qui est soit librement accessible, soit accessible uniquement aux membres..
Le site Web qui prend en charge votre cadre pourrait faire partie de votre stratégie de monétisation. Le cadre thématique hybride, par exemple, est gratuit, mais la documentation et le support du site Web qui l’accompagne ne sont disponibles que pour les abonnés payants..
Alternativement, si vous publiez votre infrastructure en tant que produit premium, vous pouvez demander aux abonnés de se connecter aux documents ou de rendre publique votre documentation, dans l’espoir d’encourager davantage de personnes à acheter..
Si votre framework est totalement gratuit, vous pouvez choisir de créer un site Web gratuit avec documentation, comme c'est le cas avec le framework Wonderflux:
Vous pouvez également décider de créer un wiki, ce qui présente l’avantage de permettre à vos utilisateurs de contribuer à la documentation. Cela prendra plus de temps à mettre en place qu'un site Web dans la plupart des cas, mais pourrait constituer un outil précieux pour la communauté utilisant votre framework. Vous pouvez créer un wiki en utilisant un plugin pour le site WordPress de votre framework.
Les didacticiels peuvent aider les nouveaux utilisateurs, en particulier ceux qui ne savent pas écrire de code, à maîtriser votre environnement plus rapidement que la documentation standard. Les vidéos vont plus loin en fournissant un guide visuel facile à utiliser et un excellent outil de marketing..
Le framework Genesis propose une gamme de tutoriels pour les utilisateurs qui ne sont disponibles que pour les abonnés payants:
Mon propre cadre Edupress contient un certain nombre de vidéos de tutoriel que j'ai créées pour aider les utilisateurs expérimentés dans le domaine de l'informatique et peu expérimentés dans l'utilisation de WordPress:
Celles-ci sont affichées sur le site Web public et également dans les tableaux de bord des utilisateurs, de sorte qu'ils puissent y accéder facilement tout en travaillant avec le cadre. Si vous créez de la documentation, des tutoriels ou des vidéos pour votre infrastructure, vous pouvez inclure un écran dans le tableau de bord avec des détails sur vos documents..
Cependant, créer des tutoriels ou des vidéos prend beaucoup de temps et nécessite beaucoup de travail pour être corrects: des tutoriels mal écrits ou des vidéos mal produites nuisent à votre structure et peuvent vous faire plus de mal qu'une simple documentation..
Quelle que soit la personne qui utilisera votre framework de thèmes, une sorte de documentation est essentielle. Que vous développiez simplement la structure pour vous et votre équipe, ou que vous la publiiez pour une utilisation plus large, vous devrez enregistrer des informations sur la structure de fichier et l'API..
Les options que j'ai évoquées ci-dessus vont des simples commentaires aux vidéos plus complexes, avec tout le reste. Ce que vous déciderez de faire dépendra des besoins de vos utilisateurs et pourrait changer avec le temps à mesure que vous gagnerez une base d'utilisateurs plus importante..
